From 5a6019967981981353ed919cf57671e2641dd5e5 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Wed, 26 Apr 2017 07:48:07 -0700 Subject: [PATCH 1/3] Add 'Unreleased' section to changelog; update 'contributing' docs **what is the change?:** - Add 'Unreleased' section to `CHANGELOG` - Add step to 'contributing' about updating the `CHANGELOG` **why make this change?:** Whoever does the release of a new React version must manually read through the recent git history and write the CHANGELOG update. If we incrementally add to the CHANGELOG under the 'Unreleased' header, as we make PRs, then to release a new version will just be updating 'Unreleased' to be the new version number and adding a blank section for 'Unreleased'. See http://keepachangelog.com/en/0.3.0/ for more info about this idea. **test plan:** Visual verification of the change, and also I built the website locally and inspected the change. **issue:** https://github.com/facebook/react/issues/9527 --- CHANGELOG.md | 2 ++ docs/contributing/how-to-contribute.md | 1 + 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3765106bc4cc..314e5fbbc2df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +## [Unreleased] + ## 15.5.0 (April 7, 2017) ### React diff --git a/docs/contributing/how-to-contribute.md b/docs/contributing/how-to-contribute.md index 3403ca379e40..f5c74c21e043 100644 --- a/docs/contributing/how-to-contribute.md +++ b/docs/contributing/how-to-contribute.md @@ -79,6 +79,7 @@ The core team is monitoring for pull requests. We will review your pull request 1. Fork [the repository](https://github.com/facebook/react) and create your branch from `master`. 2. If you've added code that should be tested, add tests! 3. If you've changed APIs, update the documentation. +4. If you have made any significant change then please [add an update to the "Unreleased" section of the change log](https://github.com/facebook/react/blob/master/CHANGELOG.md#unreleased). You may skip this step if you made documentation or dependency updates. 4. Ensure the test suite passes (`npm test`). 5. Make sure your code lints (`npm run lint`). 6. Format your code with [prettier](https://github.com/prettier/prettier) (`npm run prettier`). From 7cdf63a13be8e59bd717a26f2b81d720f7cae3e8 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Wed, 26 Apr 2017 11:26:15 -0700 Subject: [PATCH 2/3] Update numbered list in 'how to contribute' docs **what is the change?:** Fix the numbers in a list **why make this change?:** They were incorrect due to an oversight in the previous commit. **test plan:** Look at the docs. **issue:** https://github.com/facebook/react/issues/9527 --- docs/contributing/how-to-contribute.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/contributing/how-to-contribute.md b/docs/contributing/how-to-contribute.md index f5c74c21e043..aa04d4166647 100644 --- a/docs/contributing/how-to-contribute.md +++ b/docs/contributing/how-to-contribute.md @@ -80,12 +80,12 @@ The core team is monitoring for pull requests. We will review your pull request 2. If you've added code that should be tested, add tests! 3. If you've changed APIs, update the documentation. 4. If you have made any significant change then please [add an update to the "Unreleased" section of the change log](https://github.com/facebook/react/blob/master/CHANGELOG.md#unreleased). You may skip this step if you made documentation or dependency updates. -4. Ensure the test suite passes (`npm test`). -5. Make sure your code lints (`npm run lint`). -6. Format your code with [prettier](https://github.com/prettier/prettier) (`npm run prettier`). -7. Run the [Flow](https://flowtype.org/) typechecks (`npm run flow`). -8. If you added or removed any tests, run `./scripts/fiber/record-tests` before submitting the pull request, and commit the resulting changes. -9. If you haven't already, complete the CLA. +5. Ensure the test suite passes (`npm test`). +6. Make sure your code lints (`npm run lint`). +7. Format your code with [prettier](https://github.com/prettier/prettier) (`npm run prettier`). +8. Run the [Flow](https://flowtype.org/) typechecks (`npm run flow`). +9. If you added or removed any tests, run `./scripts/fiber/record-tests` before submitting the pull request, and commit the resulting changes. +10. If you haven't already, complete the CLA. ### Contributor License Agreement (CLA) From 2c6303979fadca0db1708aff609fa6d78b95cf24 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Thu, 27 Apr 2017 10:07:25 -0700 Subject: [PATCH 3/3] Wrap 'unreleased' CHANGELOG items in 'details' tag **what is the change?:** see title **why make this change?:** This will make the change log easier to read for folks who are just looking for info about the latest stable release. **test plan:** Visual inspection. **issue:** --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 314e5fbbc2df..dbc416a8d278 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,8 @@ ## [Unreleased] +
+ Changes that have landed in master but are not yet released. + Nothing yet! TODO: backfill this section. +
## 15.5.0 (April 7, 2017)