The title might have up to three primary labels. These are prefixed to the title in brackets: [primary-label] Title
. For instance, the primary label of this issue is [Tooltip]
The primary labels must match with an existing GitHub label, keeping the same format.
For instance, use [docs]
and not [Docs]
, as the GitHub label is lowercase docs
: docs.
The primary labels must have the following order depending on their category: [*Cross-package* or *package*][*platform*][*artifact*]
, the categories being:
If there’s more than one label per category (e.g., base-ui
and material-ui
), then both should be added in alphabetical order (e.g., [base-ui][material-ui]
).
We might not always create all the GitHub labels. For instance, with artifacts, it can be overwhelming. We allow the use of React component names when relevant:
[TreeItem] Fix missing type context
[tree view] Add virtualization
as the GitHub label is component: tree view.Please use the same guidelines for writing a pull request title as you would use for the git commit messages https://chris.beams.io/posts/git-commit/. Mainly, the title should stay short, use the imperative mood, have primary labels and description
Fix #1234
.Related to #1234
.Comments left in a pull request's review can be approved in two different circumstances:
Comments left in a pull request that is off-topic to the problem fixed should be prefixed with Off-topic. These comments don't need to be resolved to merge.
If the discussion can't easily be resolved a follow-up GitHub issue and pull request must be opened. It allows the initial pull request to be merged, regardless.
We empty the default description field to keep the git history clean before merging PRs. For PRs that have 50+ commits, having each commit message concatenated makes it hard to read the history, either using git log:
or a GUI like gitk. Plus the commit information has usually no value.