From 2a4d3bf095781570943db7144059715f87e17bc6 Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Fri, 16 Jan 2026 23:47:58 +0100 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=94=A7=20add=20commit/pr=20format=20t?= =?UTF-8?q?o=20AGENTS.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 2851b1d5..7e2f2ce3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -197,6 +197,43 @@ def test_example(app, status, warning, get_sphinx_app_output): assert warnings == "" ``` +## Testing Philosophy + +1. **Always add tests** for new features and bug fixes +2. **Unit tests should be atomic** โ€“ fast and focused +3. **Document test purpose** โ€“ explain *why* the test exists +4. **Use parameterized tests** (rstest/pytest) for multiple scenarios +5. **Use snapshot tests** (insta/syrupy) for complex outputs + +## 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: From dc513dd63ad3df7bb2ec59bf1984009ef342afed Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Fri, 16 Jan 2026 23:49:30 +0100 Subject: [PATCH 2/3] Update AGENTS.md --- AGENTS.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 7e2f2ce3..f74f3d2b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -197,13 +197,6 @@ def test_example(app, status, warning, get_sphinx_app_output): assert warnings == "" ``` -## Testing Philosophy - -1. **Always add tests** for new features and bug fixes -2. **Unit tests should be atomic** โ€“ fast and focused -3. **Document test purpose** โ€“ explain *why* the test exists -4. **Use parameterized tests** (rstest/pytest) for multiple scenarios -5. **Use snapshot tests** (insta/syrupy) for complex outputs ## Commit Message Format From 98d31a74aefed618b872461b91adf1f1b073b5d6 Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Fri, 16 Jan 2026 23:50:06 +0100 Subject: [PATCH 3/3] Update AGENTS.md --- AGENTS.md | 1 - 1 file changed, 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index f74f3d2b..c7681c5d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -197,7 +197,6 @@ def test_example(app, status, warning, get_sphinx_app_output): assert warnings == "" ``` - ## Commit Message Format Use this format: