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 the changelog format to reduce noise and improve readability #1143

Closed
nicolaiarocci opened this Issue May 10, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@nicolaiarocci
Member

nicolaiarocci commented May 10, 2018

Changelog format can be improved. Progress was made with the 0.8 release, whereas we added active links to relevant tickets, but I feel like it can still be improved. Ideally, I'd like to find a compromise between the guidelines proposed in places like keepachangelog and Flask's changelog, which I like. Some things to consider:

  • Rename CHANGES to CHANGES.rst, so it is properly rendered on GitHub and elsewhere
  • The same types of changes should be grouped. Right now, all those new, fix, etc. line tags add a lot of noise
  • Drop the distinction between development and stable releases. We use semantic versioning anyway.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment