Explorar el Código

Merge pull request #1257 from marcelstoer/dev-GitHub-templates

Add issue and PR templates
Johny Mattsson hace 8 años
padre
commit
1587c81973
Se han modificado 2 ficheros con 44 adiciones y 0 borrados
  1. 33 0
      .github/ISSUE_TEMPLATE.md
  2. 11 0
      .github/PULL_REQUEST_TEMPLATE.md

+ 33 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,33 @@
+Make sure you read and understand http://nodemcu.readthedocs.org/en/dev/en/support/.
+Use one of the two templates below and delete the rest.
+
+8<------------------------ BUG REPORT -----------------------------------------
+### Expected behavior
+
+### Actual behavior
+
+### Test code
+Provide a minimal and isolated test which will reproduce the problem.
+```Lua
+-- add code here
+```
+### NodeMCU version
+Which branch are you on? If you know the Git revision then add it here as well.
+
+### Hardware
+Describe which ESP8266 device you use and document any special hardware setup 
+required to reproduce the problem.
+
+8<------------------------ END BUG REPORT -------------------------------------
+
+
+8<------------------------ 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<------------------------ END FEATURE REQUEST --------------------------------

+ 11 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+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.
+
+- [ ] This PR is compliant with the [contributing guidelines](https://github.com/nodemcu/nodemcu-firmware/blob/dev/CONTRIBUTING.md) (if not, please describe why).
+- [ ] I have thoroughly tested my contribution.
+- [ ] The code changes are reflected in the documentation at `docs/en/*`.
+
+\<Description of and rational behind this PR\>
+
+Committers supporting this PR: leave blank