Skip to content

Commit 2a4d3bf

Browse files
authored
🔧 add commit/pr format to AGENTS.md
1 parent a139a1f commit 2a4d3bf

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

AGENTS.md

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

200+
## Testing Philosophy
201+
202+
1. **Always add tests** for new features and bug fixes
203+
2. **Unit tests should be atomic** – fast and focused
204+
3. **Document test purpose** – explain *why* the test exists
205+
4. **Use parameterized tests** (rstest/pytest) for multiple scenarios
206+
5. **Use snapshot tests** (insta/syrupy) for complex outputs
207+
208+
## Commit Message Format
209+
210+
Use this format:
211+
212+
```
213+
<EMOJI> <KEYWORD>: Summarize in 72 chars or less (#<PR>)
214+
215+
Optional detailed explanation.
216+
```
217+
218+
Keywords:
219+
220+
- `✨ NEW:` – New feature
221+
- `🐛 FIX:` – Bug fix
222+
- `👌 IMPROVE:` – Improvement (no breaking changes)
223+
- `‼️ BREAKING:` – Breaking change
224+
- `📚 DOCS:` – Documentation
225+
- `🔧 MAINTAIN:` – Maintenance changes only (typos, etc.)
226+
- `🧪 TEST:` – Tests or CI changes only
227+
- `♻️ REFACTOR:` – Refactoring
228+
229+
If the commit only makes changes to a single package,
230+
consider including the name in the title.
231+
232+
## PR title and description format
233+
234+
Use the same as for the commit message format,
235+
but for the title you can omit the `KEYWORD` and only use `EMOJI`
236+
200237
## Pull Request Requirements
201238

202239
When submitting changes:

0 commit comments

Comments
 (0)