Skip to content

Commit 3507531

Browse files
LVivonaseetadev
andauthored
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 <[email protected]>
1 parent 3ca27c6 commit 3507531

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

newsfragments/775.docs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarified the requirement for a trailing newline in newsfragments to pass lint checks.

newsfragments/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,19 @@ Each file should be named like `<ISSUE>.<TYPE>.rst`, where
1818
- `performance`
1919
- `removal`
2020

21-
So for example: `123.feature.rst`, `456.bugfix.rst`
21+
So for example: `1024.feature.rst`
22+
23+
**Important**: Ensure the file ends with a newline character (`\n`) to pass GitHub tox linting checks.
24+
25+
```
26+
Added support for Ed25519 key generation in libp2p peer identity creation.
27+
28+
```
2229

2330
If the PR fixes an issue, use that number here. If there is no issue,
2431
then open up the PR first and use the PR number for the newsfragment.
2532

26-
Note that the `towncrier` tool will automatically
33+
**Note** that the `towncrier` tool will automatically
2734
reflow your text, so don't try to do any fancy formatting. Run
2835
`towncrier build --draft` to get a preview of what the release notes entry
2936
will look like in the final release notes.

0 commit comments

Comments
 (0)