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

Improve changelog #124

Merged
merged 4 commits into from Feb 11, 2021
Merged

Improve changelog #124

merged 4 commits into from Feb 11, 2021

Conversation

Rlamboll
Copy link
Collaborator

@Rlamboll Rlamboll commented Jan 7, 2021

Pull request

Please confirm that this pull request has done the following:

  • Tests added
  • Documentation added (where applicable)
  • Example added (either to an existing notebook or as a new notebook, where applicable)
  • Description in CHANGELOG.rst added

Adding to CHANGELOG.rst

Please add a single line in the changelog notes similar to one of the following:

- (`#XX <https://github.com/GranthamImperial/silicone/pull/XX>`_) Added feature which does something
- (`#XX <https://github.com/GranthamImperial/silicone/pull/XX>`_) Fixed bug identified in (`#YY <https://github.com/GranthamImperial/silicone/issues/YY>`_)

Copy link
Collaborator

@znicholls znicholls left a 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.

@Rlamboll
Copy link
Collaborator Author

Rlamboll commented Jan 9, 2021

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.

@znicholls
Copy link
Collaborator

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.

@Rlamboll
Copy link
Collaborator Author

OK @znicholls, I have filed all the post-release changes as one of the required categories and got rid of the summary.

Copy link
Collaborator

@znicholls znicholls left a comment

Choose a reason for hiding this comment

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

Great

@znicholls znicholls merged commit f70a016 into master Feb 11, 2021
@znicholls znicholls deleted the improve_changelog branch February 11, 2021 21:01
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.

None yet

2 participants