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

Add changelog entry spot to checklist #591

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

Conversation

mikemhenry
Copy link
Contributor

I think adding (and making sure we are happy with) the changelog entry as part of the template will:

  1. Improve the quality of the change log entry, since that can be reviewed at commit time between the person who submitted the PR and the reviewers
  2. Prevent annoying changelog that happen when PRs all try and edit the same line in the change log.

Then at release time (we should make a release PR template) the person doing the release can copy and paste everything into the changelog on github as well as the changelog we ship with the code.

Does this sound good @jchodera ?

Copy link
Contributor

@ijpulidos ijpulidos left a comment

Choose a reason for hiding this comment

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

This works for me, we just have to be more careful when merging changes, making contributors and ourselves add the "changelog" entries to the PRs.

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.

2 participants