Use keep a changelog categories for towncrier #745
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #745 +/- ##
=======================================
Coverage 79.43% 79.43%
=======================================
Files 73 73
Lines 3608 3608
=======================================
Hits 2866 2866
Misses 742 742 ☔ View full report in Codecov by Sentry. |
lunkwill42
approved these changes
Apr 9, 2024
johannaengland
force-pushed
the
github/add-towncrier-categories
branch
from
638a303 to
f090aa1
Compare
|
hmpf
reviewed
Apr 10, 2024
| ### Before opening a PR | ||
| To be able to automatically produce the changelog for a release a file for each | ||
| ### Before merging a pull request | ||
| To be able to automatically produce the changelog for a release one file for each |
There was a problem hiding this comment.
"To be able to automatically produce the changelog for a release, one file for each..."
| or the pull request number. If we don't want to add a link to the resulting changelog | ||
| entry then a `+` followed by a unique short description. | ||
| 2. The type of the change: we use `security`, `removed`, `deprecated`, `added`, | ||
| `changed` and `fixed`. |
There was a problem hiding this comment.
Tempting to also have dependencies.
There was a problem hiding this comment.
Maybe, but can't they all be organized into either added, changed or removed? :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also adds a few improvements to the towncrier section of the README.