-
Notifications
You must be signed in to change notification settings - Fork 297
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This PR adds a template for PR descriptions, aimed to provide suffici…
…ent details about the changes being made.
- Loading branch information
Showing
2 changed files
with
39 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Description | ||
|
||
Start with a short description of what the PR does and how this is a change from | ||
the past. | ||
|
||
The rest of the description includes relevant details and context, examples: | ||
- why is this change being made, | ||
- the problem being solved and any relevant context, | ||
- why this is a good solution, | ||
- some information about the specific implementation, | ||
- shortcomings of the solution and possible future improvements. | ||
|
||
If the change fixes a bug or a Github issue, please include a link, e.g.,: | ||
FIXES: b/123456 | ||
FIXES: #123456 | ||
|
||
# Tests | ||
|
||
Please describe how you tested this change, and include any instructions and/or | ||
commands to reproduce. | ||
|
||
# Checklist | ||
|
||
Before submitting this PR, please make sure (put X in square brackets): | ||
- [ ] I have performed a self-review of my code. | ||
- [ ] I have necessary comments in my code, particularly in hard-to-understand areas. | ||
- [ ] I have run end-to-end tests tests and provided workload links above if applicable. | ||
- [ ] I have made or will make corresponding changes to the doc if needed. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
name: Require Checklist | ||
on: | ||
pull_request: | ||
types: [opened, edited, synchronize] | ||
jobs: | ||
check_pr_body: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: mheap/require-checklist-action@v2 | ||
with: | ||
requireChecklist: true # If this is true and there are no checklists detected, the action will fail |