Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Additional clarification about optional use of issue newsfragment files.

pull/2415/head
derekpierre 2020-11-03 14:49:57 -05:00
parent 020f3ea837
commit c2aad152ef
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
newsfragments/README.md
View File

@ -5,8 +5,8 @@ release notes. This should be a description of aspects of the change
commit message and PR description, which are a description of the change as
relevant to people working on the code itself.)
The PR number should be used for the newsfragment file. Each file should be
named `<PR_NUMBER>.<TYPE>.rst`, where `<TYPE>` is one of:
The pull request (PR) number should be used for the newsfragment file. Each file
should be named `<PR_NUMBER>.<TYPE>.rst`, where `<TYPE>` is one of:
* `feature`
* `bugfix`
@ -15,6 +15,11 @@ named `<PR_NUMBER>.<TYPE>.rst`, where `<TYPE>` is one of:
For example: `123.feature.rst`, `456.bugfix.rst`
Along with the required PR newsfragment file (enforced by a GitHub Action),
additional newsfragment files for issues linked to the PR can optionally be
included by following the same naming convention above, and
using `<ISSUE_NUMBER>` instead of `<PR_NUMBER>`.
Note that the `towncrier` tool will automatically
reflow your text, so don't try to do any fancy formatting. Run
`towncrier --draft` to get a preview of what the release notes entry