Skip to content

Instantly share code, notes, and snippets.

@Meowu

Meowu/RELEASE-NOTES.md

Forked from andreasonny83/RELEASE-NOTES.md
Created July 26, 2022 03:18
Show Gist options
  • Save Meowu/51a6c2f03dc4c60f0eaaa0964625a5fe to your computer and use it in GitHub Desktop.
Save Meowu/51a6c2f03dc4c60f0eaaa0964625a5fe to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @andreasonny83 andreasonny83 revised this gist Jul 21, 2019. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion RELEASE-NOTES.md
    View file
    Original file line number Diff line number Diff line change
    @@ -76,6 +76,6 @@ Example:

    ### Other Changes

    * **choreconventionalChangelog):** Add Conventional Changelog aafcdd9
    * **chore(conventionalChangelog):** Add Conventional Changelog aafcdd9
    * **docs(CHANGELOG):** Add changelog e2c7435
    ```
  2. @andreasonny83 andreasonny83 revised this gist Jul 21, 2019. 1 changed file with 27 additions and 12 deletions.
    39 changes: 27 additions & 12 deletions RELEASE-NOTES.md
    View file
    Original file line number Diff line number Diff line change
    @@ -41,26 +41,41 @@ Pro-tip: look through the github diff between the previous release to see what's
    > Description

    ### Upgrade Steps
    - [ACTION REQUIRED]
    -
    * [ACTION REQUIRED]
    *

    ### Breaking Changes
    -
    -
    *
    *

    ### New Features
    -
    -
    *
    *

    ### Bug Fixes
    -
    -
    *
    *

    ### Performance Improvements
    -
    -
    *
    *

    ### Other Changes
    -
    -
    *
    *
    ```

    Example:

    ```markdown
    ## [0.5.2](https://github.com/andreasonny83/twilio-remote-cli/compare/v0.5.1...v0.5.2) (2019-07-21)

    ### Performance Improvements

    * **dependencies:** Bump dependencies 4a4ee13

    ### Other Changes

    * **choreconventionalChangelog):** Add Conventional Changelog aafcdd9
    * **docs(CHANGELOG):** Add changelog e2c7435
    ```
  3. @andreasonny83 andreasonny83 revised this gist Jul 21, 2019. 1 changed file with 5 additions and 4 deletions.
    9 changes: 5 additions & 4 deletions RELEASE-NOTES.md
    View file
    Original file line number Diff line number Diff line change
    @@ -36,10 +36,11 @@ Pro-tip: look through the github diff between the previous release to see what's
    #### Copy and paste this template

    ```markdown
    # Version Number
    ## [0.0.2](https://github.com/andreasonny83/twilio-remote-cli/compare/v0.0.1...v0.0.2) (2019-07-21)

    > Description

    ## Upgrade Steps
    ### Upgrade Steps
    - [ACTION REQUIRED]
    -

    @@ -55,11 +56,11 @@ Pro-tip: look through the github diff between the previous release to see what's
    -
    -

    ### Improvements
    ### Performance Improvements
    -
    -

    # Other Changes
    ### Other Changes
    -
    -
    ```
  4. @andreasonny83 andreasonny83 revised this gist Jul 20, 2019. 1 changed file with 8 additions and 5 deletions.
    13 changes: 8 additions & 5 deletions RELEASE-NOTES.md
    View file
    Original file line number Diff line number Diff line change
    @@ -36,23 +36,26 @@ Pro-tip: look through the github diff between the previous release to see what's
    #### Copy and paste this template

    ```markdown
    # Upgrade Steps
    # Version Number
    > Description

    ## Upgrade Steps
    - [ACTION REQUIRED]
    -

    # Breaking Changes
    ### Breaking Changes
    -
    -

    # New Features
    ### New Features
    -
    -

    # Bug Fixes
    ### Bug Fixes
    -
    -

    # Improvements
    ### Improvements
    -
    -

  5. @andreasonny83 andreasonny83 created this gist Jul 20, 2019.
    62 changes: 62 additions & 0 deletions RELEASE-NOTES.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,62 @@
    # Release Notes Template

    > Based off https://palantir.quip.com/pzRwAVr1bpzf
    Pro-tip: look through the github diff between the previous release to see what's changed. The commit titles should give an outline of what's happened.

    ### Upgrade Steps

    - List out, as concretely as possible, any steps users have to take when they upgrade beyond just dumping the dependency.
    - Write pseudocode that highlights what code should change and how.
    - Call out if users are recommended to upgrade because of known problems with older releases.
    - Preferably, there's nothing here.

    ### Breaking Changes

    - A complete list of breaking changes (preferably there are none, unless this is a major version).

    ### New Features

    - Describe the new feature and when/why to use it. Add some pictures! Call out any caveats/warnings? Is it a beta feature?

    ### Bug Fixes

    - Call out any existing feature/functionality that now works as intended or expected.

    ### Improvements

    - Improvements/enhancements to a workflow, performance, logging, error messaging, or user experience

    ### Other Changes

    - Other miscellaneous changes that don't fit into any of the above categories. Try to leave this empty - ideally, all changes fit into the categories above

    ------

    #### Copy and paste this template

    ```markdown
    # Upgrade Steps
    - [ACTION REQUIRED]
    -

    # Breaking Changes
    -
    -

    # New Features
    -
    -

    # Bug Fixes
    -
    -

    # Improvements
    -
    -

    # Other Changes
    -
    -
    ```