-
Notifications
You must be signed in to change notification settings - Fork 47.7k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Add 'Unreleased' section to changelog; update 'contributing' docs #9532
Conversation
**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:** facebook#9527
I think the next step is to start back-filling the 'Unreleased' section, as well as adding the notes from the 15.5.* updates and for the upcoming 15.6 update. I'll work on that in a separate PR. |
Thanks @gaearon - since you are so active in reviewing PRs I am reassured that you have no issues with this change. |
We'll need to work out how this works with:
|
**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:** facebook#9527
I'm not sure this affects our decisions about where to put breaking changes. You are right that our current situation makes things complicated - we have v15.6 and the continuing snowball of 16.0, both in development at the same time. Here is my thought for that:
When something is merged to master, we add a line under 'Unreleased'. And that's how it will work post 16.0, when there is just one branch and we release from master. For now, when something gets cherry-picked from master I would move the line from 'Unreleased' to '15.6 [Unreleased]'. |
**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:**
Current plan for this:
|
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When we change this we usually also want to change the GitHub pull request template (unless you already have). It's in .github
folder.
Thinking of revisiting this now that we are getting close to the 16.0 RC. Will come back to it after wrapping up any bug fixes I can help with. |
Closing this in favor of #10730 |
what is the change?:
CHANGELOG
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:
#9527