From e3ddbf6255baff1dfab4b642cfd88885376d2c05 Mon Sep 17 00:00:00 2001 From: Itay Cohen Date: Thu, 7 Mar 2019 07:26:50 +0200 Subject: [PATCH] Update templates to hide instructions from final post (#1245) --- .github/ISSUE_TEMPLATE/bug_report.md | 15 +++++++++++---- .github/ISSUE_TEMPLATE/feature_request.md | 14 +++++++++----- .github/PULL_REQUEST_TEMPLATE.md | 14 +++++++------- 3 files changed, 27 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 191d9e5e..406ce1ee 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,9 +10,11 @@ about: Create a report to help us improve * File format: **Describe the bug** -A clear and concise description of what the bug is. + + **To Reproduce** + Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' @@ -20,10 +22,15 @@ Steps to reproduce the behavior: 4. See error **Expected behavior** -A clear and concise description of what you expected to happen. + + + **Screenshots** -If applicable, add screenshots to help explain your problem. + + + **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 ea6196a9..3fced041 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,14 +5,18 @@ about: Suggest an idea for this project --- **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 [...] + + **Describe the solution you'd like** -A clear and concise description of what you want to happen. -For UI requests, don't hesitate to post some draws. + + **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + + **Additional context** -Add any other context or screenshots about the feature request here. + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0371038c..a5d7e679 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,17 @@ -*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.* + + **Test plan (required)** -Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. + -**Code formatting** - -Make sure you ran astyle on your code before making the PR. Check our contribution guidelines here: https://cutter.re/docs/code.html + **Closing issues** -Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). +