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

Git commit message, changelog, What's New: pick two #400

Open
brettcannon opened this issue May 3, 2021 · 1 comment
Open

Git commit message, changelog, What's New: pick two #400

brettcannon opened this issue May 3, 2021 · 1 comment

Comments

@brettcannon
Copy link
Member

Do we need three different ways to communicate the same change? This is a somewhat random thought, but I'm wondering if we should consider dropping the changelog for just What's New since it's essentially a more detailed, involved changelog already? That way nothing gets accidentally missed, and anyone who needs the granularity of specific release/tag will have the git commit messages.

@gpshead
Copy link
Member

gpshead commented May 4, 2021

NEWS entries are part of the PR code review and tend to be written in a manner meaningful to users. Version control changelings often are not.

Commit messages can't be reviewed and are often a serial mismash of random on branch commit messages when bots do the message construction and merge.

In the cpython tree, I find them hit or miss. The news entry and the original issue, and even the main branch PR discussion, tend to have more useful context.

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