add GitHub templates for PRs and releases #3362
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
This commit adds: 1. a release template for GitHub releases. 2. a pull request template to help contributors and maintainers to understand and merge PRs faster, and label them correctly. When using GitHub automated release notes, PRs will be split into sections based on the following labels: - `breaking-change` or `config-change` - `dependencies` - `enhancement` - `fix` or `bug` - `plumbing`, `tests` or `deployment` - all other PRs Any labels not currently in use will be added once the PR for this commit is finalised and merged.
|
Thank you so much for writing this, I think it will make the release process way easier for everyone. The PR template looks good to me and it can be adjusted as we go if any part of it isn't working for people |
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.
This PR adds:
When using GitHub automated release notes, PRs will be split into sections based on the following labels:
breaking-changeorconfig-changedependenciesenhancementfixorbugplumbing,testsordeploymentAny labels not currently in use will be added once this PR is finalised and merged.
Note that PRs can only be in one category and will be placed in the order they are identified (i.e. a PR labelled both
enhancementandconfig-changewill appear in the first category (breaking-changeorconfig-change).