diff options
| author | James Mills <prologic@shortcircuit.net.au> | 2020-03-12 08:02:18 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-12 08:02:18 +1000 |
| commit | 9faa03df57682204290db12ea2bda032b2d16807 (patch) | |
| tree | b79d23685628bf75b843f4e7ad07f5792a4fed70 /.github/PULL_REQUEST_TEMPLATE.md | |
| parent | b4dc55a309b202b3723feab7a106c799376ea7d8 (diff) | |
Improve Pull Request template to have a shorter testing section with enhanced instructions (#8357)
* Improve Pull Request tempalte to have a shorter testing section with enhanced instructions
* Update .github/PULL_REQUEST_TEMPLATE.md
Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>
* Update .github/PULL_REQUEST_TEMPLATE.md
Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>
* Update .github/PULL_REQUEST_TEMPLATE.md
Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>
* Update .github/PULL_REQUEST_TEMPLATE.md
Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>
* Update .github/PULL_REQUEST_TEMPLATE.md
Co-Authored-By: Patti Short <35278231+shortpatti@users.noreply.github.com>
Co-authored-by: Patti Short <35278231+shortpatti@users.noreply.github.com>
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b4d96a8df1..33f7736821 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,6 +5,8 @@ Include "Fixes #nnn" if you are fixing an existing issue. In "Component Name" section write which component is changed in this PR. This will help us review your PR quicker. +In "Test Plan" provide enough detail on how you plan to test this PR so that a reviewer can validate your tests. If our CI covers sufficient tests, then state which tests cover the change. + If you have more information you want to add, write them in "Additional Information" section. This is usually used to help others understand your motivation behind this change. A step-by-step reproduction of the problem is @@ -15,12 +17,12 @@ helpful if there is no related issue. ##### Component Name -##### Description of testing that the developer performed +##### Test Plan <!--- -Please be detailed enough that your reviewer can understand which test-cases you -have covered, and recreate them if necessary. +Provide enough detail so that your reviewer can understand which test-cases you +have covered, and recreate them if necessary. If sufficient tests are covered +by our CI, then state which tests cover the change. --> -##### Additional Information - +##### Additional Information |