Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add 'Unreleased' section to CHANGELOG #9527

Closed
flarnie opened this issue Apr 26, 2017 · 2 comments
Closed

Add 'Unreleased' section to CHANGELOG #9527

flarnie opened this issue Apr 26, 2017 · 2 comments
Assignees
@flarnie

Comments

@flarnie
Copy link
Contributor

flarnie commented Apr 26, 2017

Let's make releases a bit faster/easier by keeping the CHANGELOG updated incrementally.

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.
@flarnie flarnie self-assigned this Apr 26, 2017
@flarnie
Copy link
Contributor Author

flarnie commented Apr 26, 2017

Getting this rolling will be tricky initially, but I think it's important in order to help us keep track of which features are present on master vs. the 15.* branches. Also related to #9443

@flarnie
Copy link
Contributor Author

flarnie commented Apr 26, 2017 •
edited

Relevant to this issue - (edit:) it seems like there is a big divergence between the v15.6 branch and master. If there really are 2k+ commits in v16.0 that are not present on the v15.6 branch, then writing the changelog is going to be a serious chunk of work.
screen shot 2017-04-25 at 7 49 14 pm

flarnie added a commit to flarnie/react that referenced this issue Apr 26, 2017
@flarnie
Add 'Unreleased' section to changelog; update 'contributing' docs
5a60199 
**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
@flarnie flarnie mentioned this issue Apr 26, 2017
Closed
flarnie added a commit to flarnie/react that referenced this issue Apr 27, 2017
@flarnie
Update numbered list in 'how to contribute' docs
7cdf63a 
**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
@gaearon gaearon closed this as completed Jul 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@flarnie flarnie

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gaearon @flarnie