When creating a PR:
- Use
gh pr create - Use the project's template and merge-queue conventions.
Merge-queue mapping
- PR title = commit title (Conventional Commits format).
- PR description = commit body (reusable as commit message content).
- PR title max: 72 characters.
- PR description line max: 72 characters, except long URLs, code blocks, or stack traces.
Description rules
- No headings (no
## Summaryor similar) in the PR description. - The first line must be plain context text describing the change.
- Fill
CONFIG-CHANGE:andBREAKING-CHANGE:sections when applicable. - Remove
CONFIG-CHANGE:and/orBREAKING-CHANGE:sections entirely if there is no config change or breaking change respectively. - Keep the description concise and commit-friendly.
Steps
- Run the
verifyskill if it has not been run since the last code change. All matching checks must pass before proceeding. - Review all commits on the branch
(
git logandgit diffagainst the base branch). - Draft a PR title (Conventional Commits format, 72 chars max).
- Draft a PR description following the rules above.
- Ask for confirmation from the user with all this information.
- Check if the branch needs to be pushed to remote.
- Create the PR.
- Return the PR URL.