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

Update newsfragments README document to indicate that PR number should be used for naming files.

pull/2415/head
derekpierre 2020-10-30 17:09:10 -04:00
parent 546f482aa5
commit 43b1aaace3
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
newsfragments/README.md
View File

@ -5,18 +5,15 @@ 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.)
Each file should be named like `<ISSUE>.<TYPE>.rst`, where
`<ISSUE>` is an issue number, and `<TYPE>` is one of:
The 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`
* `doc`
* `misc`
So for example: `123.feature.rst`, `456.bugfix.rst`
If the PR fixes an issue, use that number here. If there is no issue,
then open up the PR first and use the PR number for the newsfragment.
For example: `123.feature.rst`, `456.bugfix.rst`
Note that the `towncrier` tool will automatically
reflow your text, so don't try to do any fancy formatting. Run