From 93aaa52e730ea9f63642df3da10a84b91f569882 Mon Sep 17 00:00:00 2001 From: "mathieu.brunot" Date: Wed, 12 Aug 2020 13:52:56 +0200 Subject: [PATCH] :books: Add GitHub PR template Signed-off-by: mathieu.brunot --- .github/ISSUE_TEMPLATE/bug_report.md | 33 +++++++++++++---------- .github/ISSUE_TEMPLATE/feature_request.md | 3 ++- .github/PULL_REQUEST_TEMPLATE.md | 29 ++++++++++++++++++++ 3 files changed, 50 insertions(+), 15 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index be5563214..1254a84a6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,4 +1,5 @@ --- + name: Bug report about: Create a report to help us improve title: '' @@ -12,10 +13,10 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error **Expected behavior** A clear and concise description of what you expected to happen. @@ -24,25 +25,29 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- OS: (e.g. iOS) +- Browser (e.g. chrome, safari) +- Version (e.g. 22) **Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + +- Device: (e.g. iPhone6) +- OS: (e.g. iOS8.1) +- Browser (e.g. stock browser, safari) +- Version (e.g. 22) **Environment (please complete the following information):** Specify if using demo instance or self-hosted instance. If self-hosted instance, add OS and runtime information to help explain your problem. - - OS Version: [e.g. Ubuntu 16.04] + +- OS Version: (e.g. Ubuntu 16.04) Also provide Docker commands or docker-compose file if possible. - - Docker / Docker-compose Version: [e.g. Docker version 18.03.0-ce, build 0520e24] - - Image [e.g. alpine] + +- Docker / Docker-compose Version: (e.g. Docker version 18.03.0-ce, build 0520e24) +- Image (e.g. alpine) **Frontend Stack Trace (if self-hosted)** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 11fc491ef..f98a4e747 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,4 +1,5 @@ --- + name: Feature request about: Suggest an idea for this project title: '' @@ -8,7 +9,7 @@ assignees: '' --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. Ex. I'm always frustrated when (...) **Describe the solution you'd like** A clear and concise description of what you want to happen. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..e4a4e3c7b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ + + +> Please provide enough information so that others can review your pull request: + + + +> Explain the **details** for making this change. What existing problem does the pull request solve? + + + +> Screenshots/GIFs + +