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

How should changelog files be commited? #226

Open
TheNeikos opened this issue Apr 29, 2023 · 1 comment
Open

How should changelog files be commited? #226

TheNeikos opened this issue Apr 29, 2023 · 1 comment

Comments

@TheNeikos
Copy link
Contributor

Should changelog additions be committed:

  • With the changes themselves, included in the commit?
  • In a separate commit, if so what should the message be?
  • Something else?

I am wondering if suggestions could be added to the README and/or to the CONTRIBUTIONS

@matthiasbeyer
Copy link
Owner

IMO that depends on the changes that are documented.

If your changes are a bugfix and one commit, the changelog should be committed with the change. This way, if the fix was malicious, reverting it automatically reverts the changelog entry as well.

If your change is implemented in several commits, adding one more commit for the changelog is fine.
If a contributor doesnt want to use the tool, a maintainer can also file the changelog fragment in a seperate PR IMO.

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