mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-12 08:00:54 +00:00
chore: clarify newline requirement in newsfragments README.md (#775)
* chore: clarify newline requirement in README Small change in newsfragments README.md, that reduces some possible room for pull-request tox workflow errors. * style: remove double backticks for single backticks the linter strikes again XD. * docs: clarify trailing newline requirement in newsfragments for lint checks --------- Co-authored-by: Manu Sheel Gupta <manusheel.edu@gmail.com>
This commit is contained in:
1
newsfragments/775.docs.rst
Normal file
1
newsfragments/775.docs.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
Clarified the requirement for a trailing newline in newsfragments to pass lint checks.
|
||||||
@ -18,12 +18,19 @@ Each file should be named like `<ISSUE>.<TYPE>.rst`, where
|
|||||||
- `performance`
|
- `performance`
|
||||||
- `removal`
|
- `removal`
|
||||||
|
|
||||||
So for example: `123.feature.rst`, `456.bugfix.rst`
|
So for example: `1024.feature.rst`
|
||||||
|
|
||||||
|
**Important**: Ensure the file ends with a newline character (`\n`) to pass GitHub tox linting checks.
|
||||||
|
|
||||||
|
```
|
||||||
|
Added support for Ed25519 key generation in libp2p peer identity creation.
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
If the PR fixes an issue, use that number here. If there is no issue,
|
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.
|
then open up the PR first and use the PR number for the newsfragment.
|
||||||
|
|
||||||
Note that the `towncrier` tool will automatically
|
**Note** that the `towncrier` tool will automatically
|
||||||
reflow your text, so don't try to do any fancy formatting. Run
|
reflow your text, so don't try to do any fancy formatting. Run
|
||||||
`towncrier build --draft` to get a preview of what the release notes entry
|
`towncrier build --draft` to get a preview of what the release notes entry
|
||||||
will look like in the final release notes.
|
will look like in the final release notes.
|
||||||
|
|||||||
Reference in New Issue
Block a user