Contributing guidelines for new changelog generation #1787
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
Also make breaking change notation clearer.
CONTRIBUTING.md
Outdated
| *Fix another herding bug* | ||
| ``` | ||
| Notes: Fix a bug where the `herd()` function would only work on Tuesdays | ||
| other-project notes: Fix a bug where the 'Herd' button only worked on Tuesdays |
There was a problem hiding this comment.
Do I understand correctly that the other-project should get replaced with a project name? If so, could it perhaps be made more clear (<other-project> or similar), it wasn't clear to me at the start
There was a problem hiding this comment.
Yeah - maybe a real-life example will be clearer: updated.
jryans
approved these changes
Jul 14, 2021
Co-authored-by: Šimon Brandner <simon.bra.ag@gmail.com>
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
Apparently we already have this label in react SDK (for some reason) so let's use it. Plus, it's clearer that it's for changes rather than issues that cause things to break.
This was referenced Jul 14, 2021
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.
Feedback welcome!
If this looks sensible, I'll add similar to the other projects, probably customised for each.