Skip to content

Commit b967a20

Browse files
authored
🔧 Add commit/pr format to AGENTS.md (#1087)
1 parent a139a1f commit b967a20

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,35 @@ def test_example(app, status, warning, get_sphinx_app_output):
197197
assert warnings == ""
198198
```
199199

200+
## Commit Message Format
201+
202+
Use this format:
203+
204+
```
205+
<EMOJI> <KEYWORD>: Summarize in 72 chars or less (#<PR>)
206+
207+
Optional detailed explanation.
208+
```
209+
210+
Keywords:
211+
212+
- `✨ NEW:` – New feature
213+
- `🐛 FIX:` – Bug fix
214+
- `👌 IMPROVE:` – Improvement (no breaking changes)
215+
- `‼️ BREAKING:` – Breaking change
216+
- `📚 DOCS:` – Documentation
217+
- `🔧 MAINTAIN:` – Maintenance changes only (typos, etc.)
218+
- `🧪 TEST:` – Tests or CI changes only
219+
- `♻️ REFACTOR:` – Refactoring
220+
221+
If the commit only makes changes to a single package,
222+
consider including the name in the title.
223+
224+
## PR title and description format
225+
226+
Use the same as for the commit message format,
227+
but for the title you can omit the `KEYWORD` and only use `EMOJI`
228+
200229
## Pull Request Requirements
201230

202231
When submitting changes:

0 commit comments

Comments
 (0)