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

Merge pull request #2415 from derekpierre/towncrier-doc 

Update newsfragment documentation
pull/2402/head
damon c 2020-11-03 14:04:01 -08:00 committed by GitHub
parent d917a17070 c2aad152ef
commit 2eb6d1b986
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
newsfragments/2415.misc.rst Normal file
View File

@ -0,0 +1 @@
Improved newsfragments README file to clarify release note entry naming convention.

12
newsfragments/README.md
View File

@ -5,18 +5,20 @@ 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 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`
* `doc`
* `misc`
So for example: `123.feature.rst`, `456.bugfix.rst`
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.
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