-
Notifications
You must be signed in to change notification settings - Fork 14
doc: Wrote a changelog #181
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
Conversation
ChangeLog.md
Outdated
| Added | ||
| Changed | ||
| Deprecated | ||
| Removed | ||
| Fixed | ||
| Security | ||
|
|
||
| MAJOR.MINOR.PATCH | ||
| MAJOR version when you make incompatible API changes | ||
| MINOR version when you add functionality in a backward compatible manner | ||
| PATCH version when you make backward compatible bug fixes |
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.
is this some kind of instruction for the changelog? if so, should we move these lines to CONTRIBUTING.md file instead?
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... is a mistake.
|
Well, according to our workflow, we haven't yet made any public release.
The intermediate steps are development upgrades and do not consist in releases (there are not tags for them in the repo). If we are going to stick with conventional changelog, all changes, fixes etc. after the initial code will comprise the v1.0.0 release. |
|
I see. That should make it much simpler. I'll commit a new version soon. |
|
lgtm! However, I would also add to the "Added" section the addition of the orange (#96). |
|
Good job. |
Removed fixes from problems generated and solved withing the development of a same release. Listed oranges as an addition.
A proposal to close 133.