|
| 1 | +# Contribution guidelines |
| 2 | + |
| 3 | +Before starting work, read and follow [CONTRIBUTING.md](CONTRIBUTING.md), |
| 4 | +including the [Prevent agent impersonation](CONTRIBUTING.md#prevent-agent-impersonation) |
| 5 | +section governing identification when communicating through a person's account. |
| 6 | + |
1 | 7 | # Commit messages |
2 | 8 |
|
3 | | -Every commit must have a descriptive title and a substantive body. Title-only |
4 | | -commit messages are not acceptable. |
| 9 | +Follow Conventional Commits for every commit. Every commit must have a |
| 10 | +descriptive title and a substantive body. Title-only commit messages are not |
| 11 | +acceptable. |
| 12 | + |
| 13 | +## Formatting |
| 14 | + |
| 15 | +Write commit messages in Markdown and assume readers view them with syntax |
| 16 | +highlighting. Enclose code identifiers, package and module names, file paths, |
| 17 | +and shell commands in backticks. Use Markdown whenever it helps readers |
| 18 | +understand or navigate the prose. |
| 19 | + |
| 20 | +## Titles |
| 21 | + |
| 22 | +- Every title must use the form `type: description` or |
| 23 | + `type(scope): description`. |
| 24 | +- Use `feat:` for user-visible features and `fix:` for user-visible fixes. |
| 25 | +- Use appropriate prefixes for other changes, such as `docs:`, `test:`, `ci:`, |
| 26 | + `build:`, `refactor:`, `perf:`, `style:`, or `chore:`. |
| 27 | +- Breaking changes must use `!` immediately before the colon, for example |
| 28 | + `feat!:`, `refactor!:`, or a scoped form such as `fix(repo)!:`. |
| 29 | +- Optionally scope a commit to the affected component, for example `fix(repo):`. |
| 30 | + |
| 31 | +Example titles: |
| 32 | + |
| 33 | +- `feat: add support for a new Git option` |
| 34 | +- `fix(repo): handle bare repositories correctly` |
| 35 | +- `build!: drop support for an older Python version` |
| 36 | +- `ci: add an independent documentation build` |
| 37 | +- `refactor(repo): simplify repository initialization` |
| 38 | + |
| 39 | +## Body |
5 | 40 |
|
6 | 41 | The body must explain the problem or motivation, what changed, and why the |
7 | 42 | chosen approach addresses it. Include relevant behavior before and after the |
|
0 commit comments