Skip to content
Merged
Changes from 1 commit
Commits
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
37 changes: 37 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment thread
chrisjsewell marked this conversation as resolved.
Outdated

Comment thread
chrisjsewell marked this conversation as resolved.
Outdated
## 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