Skip to content

Commit

Permalink
Add note about reformatting changelog (#727)
Browse files Browse the repository at this point in the history
* Add note about reformatting changelog

* Changelog.
  • Loading branch information
dsherry committed Apr 27, 2020
1 parent 747df6a commit 6b5557e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/source/changelog.rst
Expand Up @@ -8,6 +8,7 @@ Changelog
* Changes
* Documentation Changes
* Add instructions to freeze `master` on `release.md` :pr:`726`
* Update release instructions to mention that the reformatted notes are used in two places :pr:`727`
* Testing Changes


Expand Down
2 changes: 1 addition & 1 deletion release.md
Expand Up @@ -16,7 +16,7 @@ Please use the following pattern for the branch name: "release_vX.X.X". Doing so

Make the following changes in the release PR:
* Update `setup.py` and `evalml/__init__.py` to bump `__version__` to the new version.
* Reformat the changelog to [GitHub markdown](https://guides.github.com/features/mastering-markdown/). This is currently done by hand and can be done faster with some clever text editor features.
* Reformat the changelog to [GitHub markdown](https://guides.github.com/features/mastering-markdown/). This is currently done by hand and can be done faster with some clever text editor features. You'll reuse this text in step 2.
* Move changelog items from `Future Releases` into the correct version number.
* Confirm that all release items are in the changelog under the correct header, and that no extra items are listed.

Expand Down

0 comments on commit 6b5557e

Please sign in to comment.