From 696ac38214f449f963270931acdb7e8f2ff6bdc3 Mon Sep 17 00:00:00 2001 From: Cayle Sharrock Date: Tue, 18 Dec 2018 12:57:37 +0200 Subject: [PATCH] Update issue templates (#6) (#12) * Update issue templates * Update templates * Some cosmetic changes * More wording --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/new_proposal.md | 38 ++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 18 ++++++++++++ 3 files changed, 93 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/new_proposal.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..3a354080b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[TITLE]" +labels: 'bug-report' +assignees: '' + +--- +# [TITLE] + +**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 '....' +3. Scroll down to '....' +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. + +**Desktop (please complete the following information):** + - OS & Version: [e.g. iOS 10.2.1] + - Browser & Version [e.g. chrome v71.0.12345] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser & Version [e.g. stock browser v0.1.2] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/new_proposal.md b/.github/ISSUE_TEMPLATE/new_proposal.md new file mode 100644 index 0000000000..6de1b3f31f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_proposal.md @@ -0,0 +1,38 @@ +--- +name: Idea proposal +about: Suggest an idea for this project +title: "[TITLE]" +labels: proposal +assignees: '' + +--- + +# [TITLE] + +## Metadata + +This proposal is (tick applicable): + +* [ ] A new feature +* [ ] An extension to an existing RFC/proposal +* [ ] An alternative approach to an existing RFC or proposal + +### Change log + +| Date | Changes | +|:-----|:--------| +| | | + +### Goals +_What problems is this proposal addressing?_ + +### Assumptions +_These proposals seldom live in a vacuum. The proposal might presuppose that some other feature has been implemented, or +that a certain ECC curve is used etc. List those assumptions here._ + +### Abstract +_A short summary of how the solution in this proposal works._ + +## Description + +_Type out the body of the proposal here_ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..f9bcf91fdc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +# [TITLE] + +This PR + * [ ] fixes issue #nnn + * [ ] adds a new feature + * [ ] refactors a feature + * [ ] adds new tests + * [ ] adds cosmetic changes (typos, formatting) + * [ ] Other: (...) + +# Reminders checklist +* [ ] Merging against the `development` branch +* [ ] Ran `cargo-fmt --all` before pushing + +# Description + +Describe briefly what this PR does +