From f8bb96d3d9ec4503c653e05a3d9767bc7fe33e80 Mon Sep 17 00:00:00 2001 From: Bochkarev Ivan Date: Fri, 16 Oct 2020 06:09:34 +0600 Subject: [PATCH] Update issues/PR templates (#8343) * Update issues/PR templates Signed-off-by: Bochkarev Ivan * Return the previous state of these blocks Signed-off-by: Bochkarev Ivan Co-authored-by: DMehaffy --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 23 +++++++++++++++-------- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 20 +++++++++++++++++++- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++-- 3 files changed, 46 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index f636716eb4..ad71e27736 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -1,6 +1,6 @@ --- name: 🐛 Bug Report -about: Create an issue report. +about: Create a report to help us improve Strapi. --- -**Describe the bug** +## Bug report + +### Describe the bug + A clear and concise description of what the bug is. -**Steps to reproduce the behavior** +### Steps to reproduce the behavior 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +### Expected behavior + A clear and concise description of what you expected to happen. -**Screenshots** +### Screenshots + If applicable, add screenshots to help explain your problem. -**Code snippets** +### Code snippets + If applicable, add code samples to help explain your problem. -**System** +### System - Node.js version: - NPM version: @@ -43,5 +49,6 @@ If applicable, add code samples to help explain your problem. - Database: - Operating system: -**Additional context** +### Additional context + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index 4973f3b050..9b49af68b4 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -11,7 +11,25 @@ We are using ProductBoard to manage our roadmap and feature requests. Can you please submit your feature request here: https://portal.productboard.com/strapi --> +## Feature request + +### Please describe your feature request + - [ ] **I have created my request on the Product Board before I submitted this issue** - [ ] **I have looked at all the other requests on the Product Board before I submitted this issue** -**Please describe your feature request:** +### Summary + +Quick summary what's this feature request about. + +### Why is it needed? + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Suggested solution(s) + +A clear and concise description of what you want to happen. + +### Related issue(s)/PR(s) + +Let us know if this is related to any issue/pull request. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 00a0664d93..72804870f1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,7 @@ Hello 👋 Thank you for submitting a pull request. To help us merge your PR, make sure to follow the instructions below: -- Create or update the documentation. (Should be made against the documentation branch) +- Create or update the documentation. (Should be made against the documentation branch) - Create or update the tests. - Refer to the issue you are closing in the PR description - fix #issue - Specify if the PR is in WIP (work in progress) state or ready to be merged @@ -11,4 +11,14 @@ To help us merge your PR, make sure to follow the instructions below: Please ensure you read through the Contributing Guide: https://github.com/strapi/strapi/blob/docs/contribguide/CONTRIBUTING.md --> -#### Description of what you did: +### What does it do? + +Describe the technical changes you did. + +### Why is it needed? + +Describe the issue you are solving. + +### Related issue(s)/PR(s) + +Let us know if this is related to any issue/pull request