|
| 1 | +## Template to be copy-pasted as a template for new release notes. |
| 2 | + |
| 3 | +--- |
| 4 | + |
| 5 | +<!-- |
| 6 | + I don't make a discussion thread for every release. Github has a button to make a discussion thread for a release. |
| 7 | + Then I update the discussion thread to remove the release notes and instead link to the release. |
| 8 | +--> |
| 9 | +Questions about this release? Ask in the official discussion thread: #TODO |
| 10 | + |
| 11 | +<!-- only for major releases --> |
| 12 | + |
| 13 | +*Breaking changes are prefixed with **[BREAKING]*** |
| 14 | + |
| 15 | +**Added** |
| 16 | + |
| 17 | +- Adds description of thing added (#Issue, #PR, #etc) @contributor-name |
| 18 | + <!-- list any and all relevant issues and PRs in parens above; you are not limited to exactly 1 issue and 1 PR --> |
| 19 | + <!-- nor are you limited to linking each only once. Sometimes a single PR pertains to multiple changelog entries; link to it from each --> |
| 20 | + - Optionally add details ([docs](link to docs)) |
| 21 | + - Or multiple docs links ([CLI docs](link to docusaurus page), [API docs](link to typedoc page)) |
| 22 | + |
| 23 | +**Changed** |
| 24 | + |
| 25 | +- **[BREAKING]** Make yadda yadda... |
| 26 | + |
| 27 | +**Deprecated** |
| 28 | + |
| 29 | +**Removed** |
| 30 | + |
| 31 | +**Fixed** |
| 32 | + |
| 33 | +- Fix #TODO: Description of fix (#Issue, #PR, #etc) |
| 34 | + |
| 35 | +**Docs** |
| 36 | + |
| 37 | +- In the past I've documented major improvements to docs, new docsite, new docs sections about confusing bits |
| 38 | +- In general should avoid changelog entries that do not affect ts-node consumers |
| 39 | + |
| 40 | +**Misc** |
| 41 | + |
| 42 | +- In the past I've documented improvements to testing, codecov, etc. |
| 43 | +- In general should avoid changelog entries that do not affect ts-node consumers |
| 44 | + |
| 45 | +https://github.com/TypeStrong/ts-node/compare/vTODO...vTODO |
| 46 | +https://github.com/TypeStrong/ts-node/milestone/TODO |
| 47 | + |
| 48 | +--- |
| 49 | + |
| 50 | +## Discussion thread template |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +Discussion thread for the vTODO release. |
| 55 | + |
| 56 | +[Release notes](https://github.com/TypeStrong/ts-node/releases/tag/vTODO) |
0 commit comments