Quellcode durchsuchen

chore(github): improve the PR template

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
Christina Sørensen vor 2 Jahren
Ursprung
Commit
168abd252c
2 geänderte Dateien mit 7 neuen und 17 gelöschten Zeilen
  1. 5 17
      .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
  2. 2 0
      CONTRIBUTING.md

+ 5 - 17
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -1,29 +1,17 @@
 <!--- Provide a general summary of your changes in the Title above -->
 <!--- Provide a general summary of your changes in the Title above -->
 
 
-##### Description
-<!--- Describe your changes in detail -->
-
-##### Related Issue
+<!--- Make sure you've read CONTRIBUTING.md and CODE_OF_CONDUCT.md -->
+<!---  -->
 <!--- If suggesting a major new feature or major change, please discuss it in an issue/discussions first -->
 <!--- If suggesting a major new feature or major change, please discuss it in an issue/discussions first -->
 <!--- If fixing a bug, IDEALLY there should be an issue describing it with steps to reproduce -->
 <!--- If fixing a bug, IDEALLY there should be an issue describing it with steps to reproduce -->
-<!--- Please link to the issue here: -->
-
-##### Motivation and Context
+##### Description
+<!--- Describe your changes in detail -->
 <!--- Why is this change required? What problem does it solve? -->
 <!--- Why is this change required? What problem does it solve? -->
 <!--- If it fixes an open issue, please link to the issue here. -->
 <!--- If it fixes an open issue, please link to the issue here. -->
+<!--- Consider including potentalally useful screenshots of your feature in action -->
 
 
 ##### How Has This Been Tested?
 ##### How Has This Been Tested?
 <!--- Please describe in detail how you tested your changes. -->
 <!--- Please describe in detail how you tested your changes. -->
 <!--- Include details of your testing environment, and the tests you ran to -->
 <!--- Include details of your testing environment, and the tests you ran to -->
 <!--- see how your change affects other areas of the code, etc. -->
 <!--- see how your change affects other areas of the code, etc. -->
 
 
-##### Screenshots (if appropriate):
-
-##### Checklist while waiting for a review
-- [ ] Have you performed a self review of the code?
-- [ ] Have you added adequate tests?
-- [ ] If this adds a feature, has completions been added for zsh and fish?
-- [ ] Have you updated documentation, man pages, help?
-- [ ] Have you ensured any option flags are respected?
-- [ ] Does your code pass CI tests?
-- [ ] Does your commit summaries follow conventional commits?

+ 2 - 0
CONTRIBUTING.md

@@ -65,6 +65,8 @@ vendored-openssl,git`.
 
 
 ## Creating a PR
 ## Creating a PR
 
 
+First, use the pull request template.
+
 Please make sure that the thing you worked on... actually works. Make sure to
 Please make sure that the thing you worked on... actually works. Make sure to
 also add how you ensured this in the PR description. Further, it's expected
 also add how you ensured this in the PR description. Further, it's expected
 that you do your best to check for regressions. 
 that you do your best to check for regressions.