diff --git a/AGENTS.md b/AGENTS.md index 2851b1d5..c7681c5d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -197,6 +197,35 @@ def test_example(app, status, warning, get_sphinx_app_output): assert warnings == "" ``` +## Commit Message Format + +Use this format: + +``` + : Summarize in 72 chars or less (#) + +Optional detailed explanation. +``` + +Keywords: + +- `โœจ NEW:` โ€“ New feature +- `๐Ÿ› FIX:` โ€“ Bug fix +- `๐Ÿ‘Œ IMPROVE:` โ€“ Improvement (no breaking changes) +- `โ€ผ๏ธ BREAKING:` โ€“ Breaking change +- `๐Ÿ“š DOCS:` โ€“ Documentation +- `๐Ÿ”ง MAINTAIN:` โ€“ Maintenance changes only (typos, etc.) +- `๐Ÿงช TEST:` โ€“ Tests or CI changes only +- `โ™ป๏ธ REFACTOR:` โ€“ Refactoring + +If the commit only makes changes to a single package, +consider including the name in the title. + +## PR title and description format + +Use the same as for the commit message format, +but for the title you can omit the `KEYWORD` and only use `EMOJI` + ## Pull Request Requirements When submitting changes: