Skip to content

🔧 add commit/pr format to AGENTS.md #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisjsewell merged 3 commits into from
Jan 16, 2026
+29 −0
Merged

🔧 add commit/pr format to AGENTS.md #1087

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a4d3bf
🔧 add commit/pr format to AGENTS.md
chrisjsewell Jan 16, 2026
dc513dd
Update AGENTS.md
chrisjsewell Jan 16, 2026
98d31a7
Update AGENTS.md
chrisjsewell Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,35 @@ def test_example(app, status, warning, get_sphinx_app_output):
assert warnings == ""
```

## Commit Message Format

Use this format:

```
<EMOJI> <KEYWORD>: Summarize in 72 chars or less (#<PR>)

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:
Expand Down