Skip to content

Commit 7e4a2a1

Browse files
authored
docs: add PR template convention to AGENTS.md (#272)
1 parent e918432 commit 7e4a2a1

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Summary
2+
<!-- Brief description of the changes -->
3+
4+
## Type of Change
5+
<!-- Mark one with an "x" -->
6+
- [ ] Bug fix (non-breaking change which fixes an issue)
7+
- [ ] New feature / enhancement
8+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
9+
- [ ] Documentation update
10+
- [ ] Build / dependency / tooling change
11+
- [ ] Test additions or updates
12+
- [ ] Other
13+
14+
## Related Issues
15+
<!-- Reference related issues (format: fixes #123, closes #456, or refs #456) -->
16+
17+
## Testing
18+
<!-- Describe the tests you ran and how to reproduce them -->
19+
20+
## Checklist
21+
<!-- Mark each with an "x" -->
22+
- [ ] `npm test` passes
23+
- [ ] `npm run build` succeeds
24+
- [ ] 100% test coverage maintained
25+
- [ ] No hardcoded secrets or credentials introduced
26+
- [ ] Zero external dependencies added
27+
- [ ] ES Modules only (no CommonJS in src/)

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,10 @@ When auditing or modifying AGENTS.md (or any file):
341341
3. Push the feature branch and open a PR with `gh pr create --base master`.
342342
4. Never commit or push directly to `main` or `master`.
343343

344+
### 7.4 Pull Request Templates
345+
346+
If a `.github/PULL_REQUEST_TEMPLATE.md` file exists, it MUST be used when creating PRs. Fill out every section — do not leave any section blank. If a section does not apply, write `N/A` rather than skipping it.
347+
344348
---
345349

346350
## 8. Operational Rules

0 commit comments

Comments
 (0)