From c4de9e7f1dbdbd67444cec8e75c0c39ea203630c Mon Sep 17 00:00:00 2001 From: 1998-felix Date: Wed, 23 Aug 2023 13:40:05 +0300 Subject: [PATCH] Add issue and pull request template Signed-off-by: 1998-felix --- .github/ISSUE_TEMPLATE.md | 40 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++++++++ 2 files changed, 55 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..d476b04 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,40 @@ + + +**FEATURE REQUEST** + +1. Is there an open issue addressing this request? If it does, please add a "+1" reaction to the + existing issue, otherwise proceed to step 2. + +2. Describe the feature you are requesting, as well as the possible use case(s) for it. + +3. Indicate the importance of this feature to you (must-have, should-have, nice-to-have). + +**BUG REPORT** + +1. What were you trying to achieve? + +2. What are the expected results? + +3. What are the received results? + +4. What are the steps to reproduce the issue? + +5. In what environment did you encounter the issue? + +6. Additional information you deem important: + +**ENHANCEMENT** +1. Describe the enhancement you are requesting. Enhancements include: + - tests + - code refactor + - documentation + - research + - tooling + +2. Indicate the importance of this enhancement to you (must-have, should-have, nice-to-have). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..4ce7208 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +Pull request title should be `MBD-XXX - description` or `NOISSUE - description` where XXX is ID of issue that this PR relate to. +Please review the [CONTRIBUTING.md](https://github.com/mainflux/mainflux/blob/master/CONTRIBUTING.md) file for detailed contributing guidelines. + +### What does this do? + +### Which issue(s) does this PR fix/relate to? +Put here `Resolves #XXX` to auto-close the issue that your PR fixes (if such) + +### List any changes that modify/break current functionality + +### Have you included tests for your changes? + +### Did you document any new/modified functionality? + +### Notes