diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..745686f9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,39 @@ --- -name: Bug report -about: Create a report to help us improve +name: Defect report +about: Create an issue to report an observed defect. title: '' -labels: '' -assignees: '' - +labels: 'Category-Defect, Stage0-New' +assignees: adamjstone --- -**Describe the bug** -A clear and concise description of what the bug is. +## Defect Report + +### Overview + +Replace this with a clear, consise description of the problem. + +### Reproduction steps + +Follow the instructions below, in order, to reproduce the observed behavior. + +1. Briefly state the first step. +2. And the second step. +3. And so on... + +### Observed (defective) behavior + +Explain what went wrong. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +### Expected (correct) behavior -**Expected behavior** -A clear and concise description of what you expected to happen. +Describe what should have happened. -**Screenshots** -If applicable, add screenshots to help explain your problem. +### System information -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +* Solid Instruments version: [eg. v1.0.0] +* Processor architecture: [eg. x64] +* Operating system: [eg. Windows Server 2016] -**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] +### Additional information -**Additional context** -Add any other context about the problem here. +Provide any other information that might be relevant. diff --git a/.github/ISSUE_TEMPLATE/defect-report.md b/.github/ISSUE_TEMPLATE/defect-report.md deleted file mode 100644 index e790a539..00000000 --- a/.github/ISSUE_TEMPLATE/defect-report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Defect report -about: Create an issue for an observed defect. -title: '' -labels: '> defect', '(1) under review' -assignees: adamjstone - ---- - -**Overview** - -REPLACE-ME - -**Reproduction steps** - -Follow the instructions below, in order, to reproduce the observed behavior. - -1. REPLACE-ME -2. -3. - -**Observed (defective) behavior** - -REPLACE-ME - -**Expected (correct) behavior** - -REPLACE-ME - -**System information** - -* Processor architecture: REPLACE-ME -* Operating system: REPLACE-ME - -**Additional information** - -REPLACE-ME diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d..0fd1b64a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,25 @@ --- name: Feature request -about: Suggest an idea for this project +about: Suggest a new feature. title: '' -labels: '' -assignees: '' - +labels: 'Category-Feature, Stage0-New' +assignees: adamjstone --- -**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 [...] +## Feature Request + +### Overview + +Replace this with a clear, consise description of the desired functionality. + +### Statement of Work + +The following list describes the work to be done and defines acceptance criteria for the feature. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +1. Briefly describe the first requirement. +2. And the second requirement. +3. And so on... -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Additional Information -**Additional context** -Add any other context or screenshots about the feature request here. +Provide any other information that might be relevant. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 2aa21b64..c2ce2f24 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,6 @@ - +## Pull Request -![Solid Instruments logo](SolidInstruments.Logo.Color.Transparent.500w.png) -- - - - -## Overview +### Overview This pull request addresses issue # @@ -15,7 +10,7 @@ Here is an overview of the changes that were made. 2. 3. -## Readiness checklist +### Readiness Checklist This pull request is in compliance with the readiness requirements listed below. @@ -25,4 +20,3 @@ This pull request is in compliance with the readiness requirements listed below. - [ ] All unit tests are passing. - [ ] Thorough source documentation accompanies all code additions and modifications. - [ ] Styling guidelines were followed. -- [x] I didn't read this checklist (uncheck this).