|
1 | | -## Commit Type |
| 1 | +# Description |
2 | 2 |
|
3 | | -- [ ] feat |
4 | | -- [ ] fix |
5 | | -- [ ] perf |
6 | | -- [ ] docs |
7 | | -- [ ] refactor |
8 | | -- [ ] test |
9 | | -- [ ] build |
10 | | -- [ ] ci |
11 | | -- [ ] chore |
12 | | -- [ ] style |
13 | | -- [ ] revert |
| 3 | +Please include a summary of the changes and the related issue(s) being resolved. |
14 | 4 |
|
15 | | -## Summary |
| 5 | +**Every PR must link to an issue.** If this PR intentionally has no related issue, explain why in the rationale section below. |
16 | 6 |
|
17 | | -<!-- What changed and why? --> |
| 7 | +Fixes # (issue) |
18 | 8 |
|
19 | | -## Verification |
| 9 | +> Rationale for no issue (if applicable): |
20 | 10 |
|
21 | | -<!-- Commands, screenshots, or checks used to verify the change. --> |
| 11 | +## Type of Change |
22 | 12 |
|
23 | | -## Release Notes |
| 13 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 14 | +- [ ] New feature (non-breaking change which adds functionality) |
| 15 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 16 | +- [ ] DevOps / CI / Documentation update |
24 | 17 |
|
25 | | -- [ ] User-facing change |
26 | | -- [ ] Breaking change |
27 | | -- [ ] No release note needed |
| 18 | +# 📖 API Changes & Breaking Changes Checklist |
28 | 19 |
|
29 | | -<!-- For breaking changes, include `!` in the commit type or add a `BREAKING CHANGE:` footer so the release changelog flags it. --> |
| 20 | +If your changes affect any HTTP route, request/response schema, database schema, or CLI/contract signature: |
| 21 | + |
| 22 | +- [ ] **OpenAPI Spec:** Updated `backend/src/openapi/spec.ts` (and exported `backend/openapi.json` via `npm run openapi:export`). |
| 23 | +- [ ] **API Documentation:** Updated `API.md` and/or `docs/API.md` explaining route/schema behavior changes. |
| 24 | +- [ ] **Changelog:** Added a corresponding entry in `CHANGELOG.md` under the `[Unreleased]` section. |
| 25 | +- [ ] **Migration Notes:** Provided instructions for consumers if the change is a breaking or material behavior shift. |
| 26 | + |
| 27 | +# Checklist |
| 28 | + |
| 29 | +- [ ] My code follows the style guidelines of this project |
| 30 | +- [ ] I have performed a self-review of my own code |
| 31 | +- [ ] I have commented my code, particularly in hard-to-understand areas |
| 32 | +- [ ] I have made corresponding changes to the documentation |
| 33 | +- [ ] My changes generate no new warnings |
| 34 | +- [ ] **This PR links to an issue or provides a rationale for no issue** |
| 35 | +- [ ] I have added tests that prove my fix is effective or that my feature works |
| 36 | +- [ ] New and existing unit tests pass locally with my changes |
0 commit comments