| 1 | # Changelog fragments |
| 2 | |
| 3 | Feature and fix PRs add a fragment here. **Do not edit `CHANGELOG.md` or bump version manifests** — the release workflow does that. |
| 4 | |
| 5 | You do **not** need the towncrier CLI to contribute. Fragments are ordinary Markdown files; towncrier runs only when a release is prepared. See [CONTRIBUTING.md](../CONTRIBUTING.md). |
| 6 | |
| 7 | ## Create a fragment |
| 8 | |
| 9 | ```bash |
| 10 | # Prefer the PR or issue number when you know it: |
| 11 | # changelog.d/<number>.<type>.md |
| 12 | # Orphan (no linked issue/PR yet): |
| 13 | # changelog.d/+.<type>.md or changelog.d/+short-slug.<type>.md |
| 14 | ``` |
| 15 | |
| 16 | ### Types (Keep a Changelog) |
| 17 | |
| 18 | | Suffix | Section | |
| 19 | |--------|---------| |
| 20 | | `security` | Security | |
| 21 | | `removed` | Removed | |
| 22 | | `deprecated` | Deprecated | |
| 23 | | `added` | Added | |
| 24 | | `changed` | Changed | |
| 25 | | `fixed` | Fixed | |
| 26 | |
| 27 | ### Content |
| 28 | |
| 29 | One or a few sentences of what shipped — behavior, docs, or install impact someone would care about in release notes. Link issues in the fragment body if useful; towncrier also links the number from the filename. |
| 30 | |
| 31 | ```markdown |
| 32 | General reports no longer promote unanchored fallback entity misses into synthesis. |
| 33 | ``` |
| 34 | |
| 35 | ### Skip |
| 36 | |
| 37 | Pure chores (typos in comments, CI pin bumps with nothing for release notes) can omit a fragment and check **Skip changelog** in the PR template, or add the `skip-changelog` label. |
| 38 |