-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Versioning, Change log and release instructions #1658
Conversation
29df265
to
33293e4
Compare
I'm still wondering one thing: I think we don't need to do a new release each time we merge a Pull Request. We can use common sense to gather a nice group of additions/fixes and then make a new release. Which may lead to a problem: If I want to make a new release to get my PATCH level change released, how do I know if there are unreleased MAJOR or MINOR level changes? Should we explicitly add that information to the CHANGELOG so that by reading the CHANGELOG you know what part of the version number to increase? Here's an example:
By looking at this CHANGELOG it's obvious that the next version number needs to increase the MINOR version. |
I think it would be nice if every PR comes with a corresponding entry in CHANGELOG. |
|
||
All notable changes to this project will be documented in this file. | ||
|
||
This project adheres to [Semantic Versioning](http://semver.org/). |
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.
I know this isn't legally binding text, but should this be stated with a warning? Something like "This project adheres to Semantic Versioning where possible." etc. Otherwise we might have people being surprised when a minor version change breaks existing functionality. We cannot really account for all cases like a library with a public API.
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.
That's very true. I'll change this as you suggested.
@bladealslayer I totally agree. I added a note about that in the CONTRIBUTING.md https://github.com/sharetribe/sharetribe/pull/1658/files#diff-6a3371457528722a734f3c51d9238c13R15 |
Versioning, Change log and release instructions
This PR defines a set of practises for keeping versioning/changelog/upgrade notes up-to-date:
Todo
Review tip: Click here to see how these changes look in the Github UI