From cb03595931e56a8a45078ce3cc107845aea6a5a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Tue, 19 Apr 2016 22:43:59 +0200 Subject: [PATCH] Add issue and PR templates --- .github/ISSUE_TEMPLATE.md | 33 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ 2 files changed, 44 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..fee701fd --- /dev/null +++ b/.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 -------------------------------- \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..4201cf65 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +Fixes #\. + +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/*`. + +\ + +Committers supporting this PR: leave blank \ No newline at end of file