Instruction file imported from PicnicSupermarket/error-prone-support (
.github/instructions/pull-request.instructions.md). Copyright stays with the author.
Pull Request Conventions
This document describes the conventions for creating and formatting pull
requests in this repository. For commit message conventions (which determine
the PR title and suggested commit message), see
commit-message.instructions.md.
PR title
The PR title is exactly the commit message summary line, without the (#N)
suffix. GitHub appends the PR number automatically on squash-merge.
If this PR comprises multiple commits, generate a new commit message based on the full diff, as if all changes were part of a single commit.
Label
Assign exactly one label from .github/release.yml. Read
that file for the available labels and their release note categories.
Milestone
Assign the nearest upcoming open milestone. For dependency upgrade PRs with the
dependencies label, this is handled automatically by
.github/workflows/assign-milestone.yml.
Reviewers
Assign rickie and Stephan202 as reviewers. If either of these users is the
PR author, assign mohamedsamehsalah as an additional reviewer instead of
self-reviewing.
Description format
Use the following format:
Suggested commit message:
```
{full commit message, initially without the (#N) suffix}
```
{Optional additional context not covered by the commit message.}
After the PR is created and the PR number is known, edit the description to add
the (#N) suffix to the summary line inside the code block.