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
Improve changelog #124
Improve changelog #124
Conversation
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.
Nice, is there a reason you don't want to copy the format and headings from https://keepachangelog.com/en/1.0.0/ exactly? If nothing else, adding the underlines means the restructured text will render as headings.
We can certainly add underlines if that's helpful. I didn't really see the point of having so many subsections for each version when we are releasing patches every one or two updates, but we can do if you want them. |
I completely understand that having so many sub-sections can look stupid. My issue is, I don't know how to read the CHANGELOG as it is currently formatted. I don't really know what 'important update' means and it's not obvious where to look if I want to see how my code is affected by the changes. If we just copy the keep a changelog format, yes it seems like overkill but it's easy for any users to read and it makes clear that the only things people really need to worry about (if all they want to know is, "Will my code still work?") are the fixed and changed sections. |
OK @znicholls, I have filed all the post-release changes as one of the required categories and got rid of the summary. |
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.
Great
Pull request
Please confirm that this pull request has done the following:
CHANGELOG.rst
addedAdding to CHANGELOG.rst
Please add a single line in the changelog notes similar to one of the following: