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

👷(changelog) shift changelog maintenance burden to release manager #776

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sylvinus
Copy link
Member

Most recent external contributions (including my own!) stumble on the changelog. IMHO, this represents an unnecessary friction for new contributors and a loss of focus for the reviewing team.

I propose that we put the release manager in charge of maintaining the CHANGELOG.md file at each release, based on the commits being included in that specific release. To view unreleased changes, everyone can just browse the latest commit history.

Most recent external contributions (including my own!) stumble on
the changelog. IMHO, this represents an unnecessary friction for new
contributors and a loss of focus for the reviewing team.
I propose that we put the release manager in charge of maintaining
the CHANGELOG.md file at each release, based on the commits
being included in that specific release. To view unreleased changes,
everyone can just browse the latest commit history.
@sylvinus sylvinus requested a review from sampaccoud March 19, 2025 23:45
Copy link
Member

@sampaccoud sampaccoud left a comment

Choose a reason for hiding this comment

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

Agree but it's important that we keep our commit history as good as it is now. So I propose we keep the git linters and make them informative. Then the person who merges the PR is responsible for squashing the commits and write a commit that complies whenever these tests are red.

@lunika
Copy link
Member

lunika commented Mar 20, 2025

The checks you removed are not mandatory, you can submit a PR without modifying the changelog and if you modify it then I think it's important to keep the linter do its job.
So IMHO I will not change the CI part, we can decide to let new contributors to not modify the changelog. We can modify the contributing.md file to reflect this choice, acting that modifying it is now optional for external contribution and also indicates when it should be great to update it. Most of the recent contributions are about fixing the Readme, there is no need to update the changelog for this kind of modification. But if you refactor the way media are access then yes the changelog must be modified.

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