pr-title-conventional
Included in config: 🔒 strict
A repository using this rule enforces that pull request titles follow the Conventional Commits format. Doing so helps to ensure that the purpose of a pull request is clear and consistent for humans and machines.
Specifically, keeping to the conventional commit format helps:
- Humans: it becomes easier to categorize and understand pull request purposes quickly
- Machines: automated tooling can parse those titles into semver-based releases
If a repository has this rule enabled, it’s likely aiming for either or both of those benefits.
Allowed Titles
Section titled “Allowed Titles”This rule asks that titles be in either format:
type: bodytype(scope): bodytype: the conventional commit type, such asdocsorfixscope: an optional sub-area, commonly a package name if a monorepobody: a lower-case description
Example acceptable titles include:
docs: mention 'rick' feature in README.mdfeat: add optional new 'roll' option to APIfix(parser): don't throw error on consecutive semicolonsExamples
Section titled “Examples”Pull request with a non-semantic title:
[pr-branch-non-default]
The PR title is missing a conventional commit type, such as “docs: ” or “feat: ”. This repository asks that pull request titles start with a type in the Conventional Commits format. Doing so helps make the purpose of each pull request clear for humans and machines. To resolve this report, add a conventional commit type in front of the title, like “feat: Update README.md”.