mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
3507531344
* 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>
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
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 number, and `<TYPE>` is one of:
|
|
|
|
- `breaking`
|
|
- `bugfix`
|
|
- `deprecation`
|
|
- `docs`
|
|
- `feature`
|
|
- `internal`
|
|
- `misc`
|
|
- `performance`
|
|
- `removal`
|
|
|
|
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,
|
|
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 build --draft` to get a preview of what the release notes entry
|
|
will look like in the final release notes.
|