mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-12 16:10:57 +00:00
Setup towncrier to generate release notes
This commit is contained in:
26
newsfragments/README.md
Normal file
26
newsfragments/README.md
Normal file
@ -0,0 +1,26 @@
|
||||
This directory collects "newsfragments": short files that each contain
|
||||
a snippet of ReST-formatted text that will be added to the next
|
||||
release notes. This should be a description of aspects of the change
|
||||
(if any) that are relevant to users. (This contrasts with the
|
||||
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 numbers, and `<TYPE>` is one of:
|
||||
|
||||
* `feature`
|
||||
* `bugfix`
|
||||
* `performance`
|
||||
* `doc`
|
||||
* `removal`
|
||||
* `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.
|
||||
|
||||
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
|
||||
will look like in the final release notes.
|
||||
Reference in New Issue
Block a user