Skip to content

Commit d5605d3

Browse files
authored
Merge pull request #31 from RapidField/support/0027_issue-templates
Support/0027 issue templates
2 parents 9393438 + 197b1fd commit d5605d3

4 files changed

Lines changed: 49 additions & 86 deletions

File tree

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: Defect report
3+
about: Create an issue to report an observed defect.
44
title: ''
5-
labels: ''
6-
assignees: ''
7-
5+
labels: 'Category-Defect, Stage0-New'
6+
assignees: adamjstone
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
9+
## Defect Report
10+
11+
### Overview
12+
13+
Replace this with a clear, consise description of the problem.
14+
15+
### Reproduction steps
16+
17+
Follow the instructions below, in order, to reproduce the observed behavior.
18+
19+
1. Briefly state the first step.
20+
2. And the second step.
21+
3. And so on...
22+
23+
### Observed (defective) behavior
24+
25+
Explain what went wrong.
1226

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
27+
### Expected (correct) behavior
1928

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
29+
Describe what should have happened.
2230

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
31+
### System information
2532

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
33+
* Solid Instruments version: [eg. v1.0.0]
34+
* Processor architecture: [eg. x64]
35+
* Operating system: [eg. Windows Server 2016]
3036

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
37+
### Additional information
3638

37-
**Additional context**
38-
Add any other context about the problem here.
39+
Provide any other information that might be relevant.

.github/ISSUE_TEMPLATE/defect-report.md

Lines changed: 0 additions & 37 deletions
This file was deleted.
Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Suggest a new feature.
44
title: ''
5-
labels: ''
6-
assignees: ''
7-
5+
labels: 'Category-Feature, Stage0-New'
6+
assignees: adamjstone
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
## Feature Request
10+
11+
### Overview
12+
13+
Replace this with a clear, consise description of the desired functionality.
14+
15+
### Statement of Work
16+
17+
The following list describes the work to be done and defines acceptance criteria for the feature.
1218

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
19+
1. Briefly describe the first requirement.
20+
2. And the second requirement.
21+
3. And so on...
1522

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
23+
### Additional Information
1824

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
25+
Provide any other information that might be relevant.

PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
1-
<!--
2-
Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
3-
-->
1+
## Pull Request
42

5-
![Solid Instruments logo](SolidInstruments.Logo.Color.Transparent.500w.png)
6-
- - -
7-
8-
## Overview
3+
### Overview
94

105
This pull request addresses issue #
116

@@ -15,7 +10,7 @@ Here is an overview of the changes that were made.
1510
2.
1611
3.
1712

18-
## Readiness checklist
13+
### Readiness Checklist
1914

2015
This pull request is in compliance with the readiness requirements listed below.
2116

@@ -25,4 +20,3 @@ This pull request is in compliance with the readiness requirements listed below.
2520
- [ ] All unit tests are passing.
2621
- [ ] Thorough source documentation accompanies all code additions and modifications.
2722
- [ ] Styling guidelines were followed.
28-
- [x] I didn't read this checklist (uncheck this).

0 commit comments

Comments
 (0)