Add more structure and guidance

- contribution guidelines
- GitHub templates
- new paragraph in README
This commit is contained in:
Marcel Stör
2018-04-15 20:29:19 +02:00
parent b154356c33
commit aab7dde9d8
5 changed files with 145 additions and 1 deletions

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

@@ -0,0 +1,32 @@
Use one of the two templates below and delete the rest.
8<------------------------ 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.
```c
// add code here
```
### Weather Station Color version
Which branch are you on? If you know the Git revision then add it here as well.
### Hardware
Describe whether you run the code on the ThingPulse Weather Station Color kit or on some custom hardware.
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 --------------------------------

9
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,9 @@
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 [other contributing guidelines](https://github.com/ThingPulse/esp8266-weather-station-color/blob/master/CONTRIBUTING.md) as well (if not, please describe why).
- [ ] I have thoroughly tested my contribution.
- [ ] Should this code require changes to documentation I will contribute those to [https://github.com/ThingPulse/docs](https://github.com/ThingPulse/docs).
\<Description of and rationale behind this PR\>