-
Notifications
You must be signed in to change notification settings - Fork 5k
Add a pull request template providing valuable information when reviewing a PR #15388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
59ae739
Add a PR template that provides valuable information when reviewing a PR
mdelapenya 70a5d05
Add CLA check
mdelapenya 8ae6cdb
Fix typo
mdelapenya de75df0
Address comments during review
mdelapenya dc7c628
SF: Fix typo
mdelapenya de02577
Add deprecation as PR type
mdelapenya bdd5d0a
Make it clear how to strike through in markdown
mdelapenya c05e654
Add default configuration files to the checklist
mdelapenya File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| <!-- Type of change | ||
| Please label this PR with one of the following labels, depending on the scope of your change: | ||
| - Bug | ||
| - Enhancement | ||
| - Breaking change | ||
| - Deprecation | ||
| --> | ||
|
|
||
| ## What does this PR do? | ||
|
|
||
| <!-- Mandatory | ||
| Explain here the changes you made on the PR. Please explain the WHAT: patterns used, algorithms implemented, design architecture, message processing, etc. | ||
| --> | ||
|
|
||
| ## Why is it important? | ||
|
|
||
| <!-- Mandatory | ||
| Explain here the WHY, or the rationale/motivation for the changes. | ||
| --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| <!-- Mandatory | ||
| Add a checklist of things that are required to be reviewed in order to have the PR approved | ||
|
|
||
| List here all the items you have verified BEFORE sending this PR. Please DO NOT remove any item, striking through those that do not apply. (Just in case, strikethrough uses two tildes. ~~Scratch this.~~) | ||
| --> | ||
|
|
||
| - [ ] My code follows the style guidelines of this project | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
|
urso marked this conversation as resolved.
|
||
| - [ ] I have made corresponding change to the default configuration files | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
|
|
||
| ## Author's Checklist | ||
|
|
||
| <!-- Recommended | ||
| Add a checklist of things that are required to be reviewed in order to have the PR approved | ||
| --> | ||
| - [ ] | ||
|
|
||
| ## How to test this PR locally | ||
|
|
||
| <!-- Recommended | ||
| Explain here how this PR will be tested by the reviewer: commands, dependencies, steps, etc. | ||
| --> | ||
|
|
||
| ## Related issues | ||
|
|
||
| <!-- Recommended | ||
| Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it. | ||
|
|
||
| - Closes #123 | ||
| - Relates #123 | ||
| - Requires #123 | ||
| - Superseds #123 | ||
| --> | ||
| - | ||
|
|
||
| ## Use cases | ||
|
|
||
| <!-- Recommended | ||
| Explain here the different behaviors that this PR introduces or modifies in this project, user roles, environment configuration, etc. | ||
|
|
||
| If you are familiar with Gherkin test scenarios, we recommend its usage: https://cucumber.io/docs/gherkin/reference/ | ||
| --> | ||
|
|
||
| ## Screenshots | ||
|
|
||
| <!-- Optional | ||
| Add here screenshots about how the project will be changed after the PR is applied. They could be related to web pages, terminal, etc, or any other image you consider important to be shared with the team. | ||
| --> | ||
|
|
||
| ## Logs | ||
|
|
||
| <!-- Recommended | ||
| Paste here output logs discovered while creating this PR, such as stack traces or integration logs, or any other output you consider important to be shared with the team. | ||
| --> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.