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 a change log #426

Merged
merged 1 commit into from Oct 10, 2018

Conversation

@evertrol
Copy link
Contributor

evertrol commented Oct 8, 2018

Adds an initial (template) change log, with a description on its usage
in the CONTRIBUTING documentation.

@evertrol

This comment has been minimized.

Copy link
Contributor Author

evertrol commented Oct 8, 2018

This adds an initial change log, as briefly discussed in #421 (comment)

This change log should probably not be merged (yet) as is, since the three issues shown in the log are not merged yet: these serve as example entries.

A description on suggested usage is given in CONTRIBUTING.md

Ideas were taken from the scikit-learn and the Astropy projects.

@evertrol evertrol referenced this pull request Oct 8, 2018
CHANGES.rst Outdated
@@ -0,0 +1,58 @@
Version 0.7 (unreleased)

This comment has been minimized.

Copy link
@betatim

betatim Oct 8, 2018

Member

We follow semver and I don't think we will have two releases "on the go" in parallel for quite a while. This means that we will keep releasing 0.6.x until we have changes that require us to bump to 0.7.0. And then there won't be any more 0.6.x+1 releases ever again.

So I'd write Version 0.x (unreleased) here to have it all together. I think this will make it easy to put "Version 0.6.13" at short notice and release it when we are about to merge a PR that will move us to 0.7. Instead of having to have that PR hang around a long time. WDYT?

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Oct 8, 2018

I like it as it is here. I think we should try and make it as simple as possible both for contributors and for ourselves so simplifying the language and format around adding a change to:

"Find the relevant section Feature/Bug fix/API change for the next release at the top of the file and add one to two sentences ..."

Maybe with a hint/tip to only do it just before the PR is going to be merged as we will hit merge conflicts that need resolving if something else gets merged in the mean time.

@choldgraf

This comment has been minimized.

Copy link
Collaborator

choldgraf commented Oct 8, 2018

I think this is a really nice addition, +1 when @betatim is happy

@evertrol evertrol force-pushed the evertrol:add-changelog branch 2 times, most recently from 1401d51 to cc376a7 Oct 9, 2018
@evertrol

This comment has been minimized.

Copy link
Contributor Author

evertrol commented Oct 9, 2018

Thanks for the response.
I've made a few minor changes (I couldn't get myself to delete all bullet points in the contributing section yet, so I've put that in a "Details" part). The new version number template is now a generic x.y.z; that can serve any purpose.

I'll leave it here for a few days for others to comment. Once there's nothing more, I'll remove the example bullet points that aren't merged yet, so that it is correct for the current status and it can be merged.

@evertrol evertrol force-pushed the evertrol:add-changelog branch from cc376a7 to f35d27b Oct 9, 2018
@betatim

This comment has been minimized.

Copy link
Member

betatim commented Oct 9, 2018

Needs a bit of coordinating with #427 for potential merge conflicts/garbled sentences.

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Oct 9, 2018

Not sure how many others will comment in the next few days as life here is pretty quiet at the moment. Let's wait for Chris to wake up and if he is happy with it merge this. That would be my suggestion for moving forwards.

@evertrol

This comment has been minimized.

Copy link
Contributor Author

evertrol commented Oct 9, 2018

I'm happy to wait for #427 to be merged first, and then update this PR with those changes.

@choldgraf

This comment has been minimized.

Copy link
Collaborator

choldgraf commented Oct 9, 2018

This seems good to me! Perhaps we can tweak over time if there are some changes to be made, but this is a definite improvement! Once you resolve the merge conflicts I'm +1

Adds an initial (template) change log, with a description on its usage
in the CONTRIBUTING documentation.
@evertrol evertrol force-pushed the evertrol:add-changelog branch from f35d27b to 3a99a5c Oct 10, 2018
@betatim betatim merged commit dc3114f into jupyter:master Oct 10, 2018
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@betatim

This comment has been minimized.

Copy link
Member

betatim commented Oct 10, 2018

Merged.

We might become a real grown up project after all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.