Show deprecations first in release notes #1102
Closed
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 Report
@@ Coverage Diff @@
## master #1102 +/- ##
=======================================
Coverage 99.54% 99.54%
=======================================
Files 102 102
Lines 12501 12501
Branches 950 950
=======================================
Hits 12444 12444
Misses 36 36
Partials 21 21 |
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #1102 +/- ##
=======================================
Coverage 99.54% 99.54%
=======================================
Files 102 102
Lines 12501 12501
Branches 950 950
=======================================
Hits 12444 12444
Misses 36 36
Partials 21 21 |
|
Maybe after features but before bugfixes? It should be more prominent than it is, but I'm a little nervous about making it seem like all we do is break stuff :-) |
|
Hmm, I thought it was common to show deprecations/breaking changes first (as a library user, it's always the first section I read) but it looks like it's not: Closing, thanks for the review. |
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.
I've noticed this issue because of #1099. I believe deprecations should be shown before features and bugfixes. This pull request can be tested with
towncrier --draft.