Add issue and PR templates

This commit is contained in:
Marcel Stör 2016-04-19 22:43:59 +02:00
parent 25b4285c4d
commit cb03595931
2 changed files with 44 additions and 0 deletions

33
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -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
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -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