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

Change CONTRIBUTING.md according to new changelog requirements #2839

Merged
merged 4 commits into from
Feb 24, 2024

Conversation

einfachIrgendwer0815
Copy link
Contributor

In PR #2766 (bcc2de86) a new workflow was added which ensures that the CHANGELOG 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:

If your contribution changes the behavior of bat (as opposed to a typo-fix
in the documentation), please update the CHANGELOG.md file
and describe your changes.

So, do PRs like this one need a changelog entry? I think CONTRIBUTING.md says no, but the workflow will fail nonetheless.

Copy link
Collaborator

@keith-hall keith-hall left a comment

Choose a reason for hiding this comment

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

Nice, this should bring some clarification, thanks. 👍
I agree that the Github Actions workflow doesn't match the contributing guidelines, perhaps it will make sense to edit the workflow to make updating the changelog optional for purely documentation changes etc.

@Enselic
Copy link
Collaborator

Enselic commented Feb 7, 2024

So, do PRs like this one need a changelog entry? I think CONTRIBUTING.md says no, but the workflow will fail nonetheless.

The way I see it, it's fine if the Changelog job fails if there is no need to add something to the changelog. It can simply be ignored.

Maybe we can clarify that in the docs too somehow?

Copy link
Collaborator

@Enselic Enselic left a comment

Choose a reason for hiding this comment

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

Thank you

@einfachIrgendwer0815 einfachIrgendwer0815 deleted the explain_changelog_format branch February 24, 2024 20:54
@einfachIrgendwer0815 einfachIrgendwer0815 restored the explain_changelog_format branch February 24, 2024 21:12
@Enselic Enselic merged commit 487bed2 into sharkdp:master Feb 24, 2024
21 of 22 checks passed
@einfachIrgendwer0815 einfachIrgendwer0815 deleted the explain_changelog_format branch February 25, 2024 09:19
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.

3 participants