From c671a329d5e3dc2e9ebe97a74693d15406d461fe Mon Sep 17 00:00:00 2001 From: Andrew Bradley Date: Mon, 11 Oct 2021 13:54:05 -0400 Subject: [PATCH] add template for release notes --- development-docs/release-template.md | 56 ++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 development-docs/release-template.md diff --git a/development-docs/release-template.md b/development-docs/release-template.md new file mode 100644 index 000000000..e1f32c582 --- /dev/null +++ b/development-docs/release-template.md @@ -0,0 +1,56 @@ +## Template to be copy-pasted as a template for new release notes. + +--- + + +Questions about this release? Ask in the official discussion thread: #TODO + + + +*Breaking changes are prefixed with **[BREAKING]*** + +**Added** + +- Adds description of thing added (#Issue, #PR, #etc) @contributor-name + + + - Optionally add details ([docs](link to docs)) + - Or multiple docs links ([CLI docs](link to docusaurus page), [API docs](link to typedoc page)) + +**Changed** + +- **[BREAKING]** Make yadda yadda... + +**Deprecated** + +**Removed** + +**Fixed** + +- Fix #TODO: Description of fix (#Issue, #PR, #etc) + +**Docs** + +- In the past I've documented major improvements to docs, new docsite, new docs sections about confusing bits +- In general should avoid changelog entries that do not affect ts-node consumers + +**Misc** + +- In the past I've documented improvements to testing, codecov, etc. +- In general should avoid changelog entries that do not affect ts-node consumers + +https://github.com/TypeStrong/ts-node/compare/vTODO...vTODO +https://github.com/TypeStrong/ts-node/milestone/TODO + +--- + +## Discussion thread template + +--- + +Discussion thread for the vTODO release. + +[Release notes](https://github.com/TypeStrong/ts-node/releases/tag/vTODO)