diff options
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 74f9918e2..829d8e647 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,23 +1,27 @@ +##### Summary <!-- Describe the change in summary section, including rationale and design decisions. Include "Fixes #nnn" if you are fixing an existing issue. - -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 -helpful if there is no related issue. --> -##### Summary - ##### Test Plan -<!--- -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. +<!-- +Provide enough detail so that your reviewer can understand which test cases you +have covered, and recreate them if necessary. If our CI covers sufficient tests, then state which tests cover the change. --> ##### Additional Information +<!-- This is usually used to help others understand your +motivation behind this change. A step-by-step reproduction of the problem is +helpful if there is no related issue. --> + +<details> <summary>For users: How does this change affect me?</summary> + <!-- +Describe the PR affects users: +- Which area of Netdata is affected by the change? +- Can they see the change or is it an under the hood? If they can see it, where? +- How is the user impacted by the change? +- What are there any benefits of the change? +--> +</details> |