Skip to content

Add pre-merge checklist in core developer guide #653

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

Open
jni opened this issue Apr 4, 2025 · 0 comments
Open

Add pre-merge checklist in core developer guide #653

jni opened this issue Apr 4, 2025 · 0 comments

Comments

@jni
Copy link
Member

jni commented Apr 4, 2025

Our core developer guide has a section on reviewing, but it is missing essential information about merge-time conventions/etiquette. Especially now that @willingc is advocating for getting rid of the "ready to merge" wait period, I think it's important to add to the guide everything that needs to happen before a PR is merged:

  • check the type label type (feature, label, performance, etc)
  • check the milestone
  • check discussion comments are addressed or an issue is made to keep track of remaining to-dos
  • make sure the title still reflects the state/purpose of the PR
  • make sure the description reflects the current state/purpose of the PR (it's encouraged to leave the original description underneath under the heading "original description", since it provides the context for the subsequent discussion on the PR itself. However, the description becomes the commit message, so it should reflect the status of the PR at the time of merging.)

Some of those checks should ideally be automated, so we could perhaps rename "ready to merge" to "final checks" and keep it only for the automations, not for the wait period.

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

1 participant