Skip to content
This repository was archived by the owner on Jul 22, 2020. It is now read-only.

Commit 5f899f8

Browse files
committed
Added GitHub PR and Issue template
1 parent 8a74bac commit 5f899f8

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!-- NOTE: Uncomment the template you wish to use -->
2+
3+
<!-- -------------------------------------------------------------- -->
4+
<!-- FEATURE / ENHANCEMENT TEMPLATE -->
5+
<!-- -------------------------------------------------------------- -->
6+
<!--
7+
## Outcome Desired
8+
9+
*<Write what outcome would be achieved through the completion of this story.>*
10+
11+
<hr>
12+
13+
## Definition of Done
14+
15+
*<Write some conditions that marks this feature as done.>*
16+
17+
<hr>
18+
19+
## Out of Scope
20+
21+
*<Write the items / activities that are out of scope for this feature (which may be included in future features).>*
22+
23+
<hr>
24+
25+
## How to Demo
26+
27+
*<Describe, in steps, how to demo the completed feature.>*
28+
-->
29+
30+
<!-- -------------------------------------------------------------- -->
31+
<!-- ISSUE TEMPLATE -->
32+
<!-- -------------------------------------------------------------- -->
33+
<!--
34+
## Expected Behaviour
35+
36+
*<Describe the expected behaviour.>*
37+
38+
<hr>
39+
40+
## Actual Behaviour
41+
42+
*<Describe what actually happens. Include relevant information where possible (e.g. error logs).>*
43+
44+
<hr>
45+
46+
## Steps to Reproduce
47+
48+
*<Describe, in steps, how to reproduce the problem.>*
49+
-->
50+
51+
<!-- -------------------------------------------------------------- -->
52+
<!-- CHORE TEMPLATE -->
53+
<!-- -------------------------------------------------------------- -->
54+
<!--
55+
## Context
56+
57+
*<Write some contextual information about the chore.>*
58+
59+
<hr>
60+
61+
## Definition of Done
62+
63+
*<Write some conditions that marks this chore as done.>*
64+
-->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Summary
2+
3+
<!-- NOTE: Remove as necessary -->
4+
Completes feature #*<GitHub issue number>*
5+
Completes chore #*<GitHub issue number>*
6+
Fixes issue #*<GitHub issue number>*
7+
8+
Related tickets: #*<GitHub issue number>*
9+
10+
*<Write a short summary of your changes.>*
11+
12+
<hr>
13+
14+
## Pull Request (PR) Checklist
15+
16+
### Documentation
17+
- [ ] Documentation in `README.md` or Wiki updated
18+
19+
### Code Review
20+
- [ ] Self code review -- take another pass through the changes yourself
21+
- [ ] Completed all relevant `TODO`s, or call them out in the PR comments
22+
23+
### Tests
24+
- [ ] All tests passes

0 commit comments

Comments
 (0)