Skip to content

Commit cdab8db

Browse files
authored
docs: adopt core PR-description rules in AGENTS.md (#202)
1 parent 48eff7f commit cdab8db

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,23 @@ Most folders are self-explanatory (`screens/`, `components/`, `utils/`, `i18n/`,
108108

109109
Both Detox jobs install evcc + Caddy in CI before running. If you add a test that needs more services, mirror that setup in both jobs.
110110

111+
## Pull Request Descriptions
112+
113+
Structure PR descriptions in this order. No headlines. Be concise.
114+
115+
1. **References first line**: link related issues or PRs (`fixes #1123`, `replaces #222`, `pairs with evcc-io/evcc#345`). PRs should almost always reference an issue or related PR — only skip in rare exceptions (e.g. trivial typo fixes).
116+
2. **Intro**: one or a few concise sentences framing what the PR does and why it was created this way. The full problem description belongs in the linked issue, not here.
117+
3. **Bullet list**: most significant changes or user-facing implications. Lead with the most significant.
118+
4. **TODO section** (only if open points remain):
119+
120+
```
121+
**TODO**
122+
- [ ] item a
123+
- [ ] item b
124+
```
125+
126+
Avoid file paths, line numbers, or code listings reproduced from the diff. Include a code snippet only when it conveys the contract (event shape, API signature) more clearly than prose. No testing checklists, no co-author footers, no generator footers.
127+
111128
## Git Workflow
112129

113130
- Main branch: `main`

0 commit comments

Comments
 (0)