Przeglądaj źródła

Add github issue and PR templates

zhaozhongxiang 7 lat temu
rodzic
commit
0490badeef
2 zmienionych plików z 53 dodań i 0 usunięć
  1. 45 0
      .github/ISSUE_TEMPLATE.md
  2. 8 0
      .github/PULL_REQUEST_TEMPLATE.md

+ 45 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+Make sure you read and understand this document.
+Use one of the two templates below and delete the rest.
+
+- [ ] BUG REPORT
+- [ ] FEATURE REQUEST
+
+-------------------------------------------------------------------------------
+> BUG REPORT
+
+### Expected behavior
+
+### Actual behavior
+
+### Test code
+
+Provide a [Minimal, Complete, and Verifiable example](http://stackoverflow.com/help/mcve) which will reproduce the problem.
+
+```bash
+# Add code here
+```
+
+### Document version
+
+Which branch are you on? If you know the Git revision then add it here as well.
+
+### Hardware
+
+Which hardware do you use?
+
+### System
+
+What system do you use?
+
+-------------------------------------------------------------------------------
+> FEATURE REQUEST
+
+### Missing feature
+
+### Justification
+
+Tell us why you would like to see this feature added.
+
+### Workarounds
+
+Are there any workarounds you currently have in place because the feature is missing?

+ 8 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+Fixes #\<GitHub-issue-number\>.
+
+Make sure all boxes are checked (add x inside the brackets) when you submit your contribution, remove this sentence before doing so.
+
+- [ ] I have thoroughly tested my contribution.
+- [ ] The code I submitted has no copyright issues.
+
+\<Description of and rational behind this PR\>