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

Add changelog #92

Open
emi80 opened this issue Dec 3, 2020 · 1 comment
Open

Add changelog #92

emi80 opened this issue Dec 3, 2020 · 1 comment

Comments

@emi80
Copy link
Member

emi80 commented Dec 3, 2020

Hi all,

I think having a list of changes/fixes/new features for each release would be very useful.
In my opinion, we should keep this information in both:

  • the repository README.md file (or a CHANGELOG.md file)
  • each GitHub release description (only the changes relevant to the release)

Having it in the release description would be very handy when looking at a particular release, without the need to open a different document to get the changelog.

Any thoughts?

Best,
Emilio

@saupchurch
Copy link
Contributor

There is a changeling section in the API. I do agree that it should either be moved to or mirrored in the README

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

No branches or pull requests

2 participants