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.

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

Add NEWS.md, a human-readable list of changes #263

Merged
merged 1 commit into from
Feb 18, 2016

Conversation

malept
Copy link
Member

@malept malept commented Feb 14, 2016

As mentioned in #235 (comment) and #223 (comment).

Only contains changes from 5.2.0 onward. If someone else wants to backfill, feel free 😁


### Added

* Add `tmpdir` parameter to specify a custom temp directory (#230)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opinions on whether to actually link the PRs? I kind of wish GitHub would automatically do so.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we were to use GitHub's releases feature instead of add a file to the repo ourselves, it automatically links issues there.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose we do both. This way the person tagging the release is not on the hook to gather the release notes, it should be gathered as changes are added.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, any contributor is able to create or edit a release draft on github at any time to keep track of release notes ahead of an actual release; e.g. with dgrid I try to keep a draft updated as each thing gets merged. Just have to be careful not to prematurely click the big green button on the page (why do they have to always have tempting big green buttons?!)

Not sure if that influences your thought of doing both a NEWS.md and github release notes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just have to be careful not to prematurely click the big green button on the page (why do they have to always have tempting big green buttons?!)

Yeah, today I already accidentally clicked the "close PR" button.

The nice thing about the NEWS.md approach is that a user can tell what's unreleased - using just GitHub Releases doesn't really help with that use case. I have needed to figure out if feature X has been released or not when responding to issues.

@malept
Copy link
Member Author

malept commented Feb 15, 2016

I added GitHub compare links to the version names, but for whatever reason, the diffs aren't quite right.

@malept malept added this to the Next major or minor version after 5.2.1 milestone Feb 17, 2016
malept added a commit that referenced this pull request Feb 18, 2016
Add NEWS.md, a human-readable list of changes
@malept malept merged commit b133e58 into electron:master Feb 18, 2016
@malept malept deleted the add-news-file branch February 18, 2016 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants