docs: Capture UX-oriented practices for changelog#9284
Merged
thanethomson merged 3 commits intomainfrom Aug 20, 2022
Merged
Conversation
Signed-off-by: Thane Thomson <connect@thanethomson.com>
CONTRIBUTING.md
Outdated
Comment on lines
+156
to
+158
| Changelog entries should answer the question: "what is important about this | ||
| change for users to know?" and should not simply be a reiteration of the title | ||
| of the associated PR. Changelog entries should be formatted as follows: |
Contributor
There was a problem hiding this comment.
I'm wondering if you could provide some examples? In general, what do we think it's important for our users to understand beyond what the change was? I guess I'm not clear on how this is that distinct from the title of the pull request.
Contributor
Author
There was a problem hiding this comment.
Would links to some resources like https://keepachangelog.com/en/1.0.0/ perhaps help? It seems to me like what I'm asking for here is pretty standard, but perhaps it's not as well-understood as I thought?
Signed-off-by: Thane Thomson <connect@thanethomson.com>
bb82332 to
7f7ec80
Compare
cmwaters
approved these changes
Aug 18, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Closes #8996.
📖
CONTRIBUTING.mdguidelines rendered