From 0490badeef5f205f34a07e0b732c73f0dfe88f7b Mon Sep 17 00:00:00 2001 From: zhaozhongxiang Date: Fri, 21 Sep 2018 17:05:12 +0800 Subject: [PATCH] Add github issue and PR templates --- .github/ISSUE_TEMPLATE.md | 45 ++++++++++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 8 +++++++ 2 files changed, 53 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 0000000..35c5204 --- /dev/null +++ b/.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? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3a40a8f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,8 @@ +Fixes #\. + +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. + +\ \ No newline at end of file