Skip to content

Commit 0877a37

Browse files
authored
Issue and PR templates
1 parent c5e606d commit 0877a37

File tree

4 files changed

+77
-21
lines changed

4 files changed

+77
-21
lines changed
Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,29 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
3+
about: Report a bug!
4+
title: A brief description of the bug
5+
labels: Bug
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
## Describe the bug
11+
A clear and concise description of what the bug is. Use screenshots!
1212

13-
**To Reproduce**
13+
### To reproduce
1414
Steps to reproduce the behavior:
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
1818
4. See error
1919

20-
**Expected behavior**
20+
### Expected behaviour
2121
A clear and concise description of what you expected to happen.
2222

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
23+
### Version and device info
24+
- App version:
25+
- Tablet model:
26+
- OS version:
2527

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30-
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]
36-
37-
**Additional context**
28+
### Additional context
3829
Add any other context about the problem here.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Design discussion
3+
about: A template for how to discuss designing features/modules
4+
title: Feature/module name and concise purpose if not conveyed in name
5+
labels: Epic
6+
assignees: ''
7+
8+
---
9+
10+
<!-- It's expected that this template be edited and kept up to date as discussion around the design unfolds -->
11+
## Description
12+
<!-- Summarise the related features/module that is needed -->
13+
14+
### Context
15+
<!-- Describe what use case wasn't being satisfied in the current version of mSupply Mobile that the above is address -->
16+
17+
## Design discussion
18+
<!-- Summarise the solution. Add child issues with checkboxes if created. Delete sub sections if not applicable -->
19+
20+
### Page/navigation Changes
21+
<!-- Summarise Page/navigation changes. -->
22+
23+
### Schema Changes
24+
<!-- Summarise any realm schema changes required if any -->
25+
26+
### Sync Changes
27+
<!-- Touch on any sync changes that may be required -->
28+
29+
### Architecture
30+
<!-- If any, describe design pattern decisions -->
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: Concisely the feature I want
5+
labels: Feature
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem? Please describe.
11+
12+
__A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]__
13+
14+
## Describe the solution you'd like
15+
16+
__A clear and concise description of what you want to happen.__
17+
18+
## Describe alternatives you've considered
19+
20+
__A clear and concise description of any alternative solutions or features you've considered.__
21+
22+
## Additional context
23+
24+
__Add any other context or screenshots about the feature request here.__

.github/pull_request_template.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Fixes #?
2+
3+
## Change summary
4+
Explain and justify your changes
5+
6+
## Testing
7+
Steps to reproduce or otherwise test the changes of this PR:
8+
- [ ] Do something
9+
10+
### Related areas to think about
11+
If there are any general areas of the codebase your changes might have side affects on, mention them here

0 commit comments

Comments
 (0)