Change CONTRIBUTING.md according to new changelog requirements #2839
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In PR #2766 (
bcc2de86
) a new workflow was added which ensures that theCHANGELOG
stays up to date and that entries follow a certain format. However, this has led to quite a bit of confusion among contributors (#2827 (comment)). For example, the authors of #2827, #2807, #2835 and #2818 had to modify the changelog multiple times to match the requirements.To solve that, this PR changes CONTRIBUTING.md according to the new format requirements. Also, a note is added to the workflow to point contributors in the right direction.
But I do have a question that I'm myself confused about. The CONTRIBUTING.md states:
So, do PRs like this one need a changelog entry? I think CONTRIBUTING.md says no, but the workflow will fail nonetheless.