Skip to content

Commit 017b544

Browse files
jmgatejmgate
committed
chore: Add GitHub issur/PR templates
1 parent 8c04e16 commit 017b544

File tree

9 files changed

+194
-0
lines changed

9 files changed

+194
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug
3+
about: What went wrong?
4+
title: ''
5+
labels: 'Type: Bug'
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
* What went wrong?
12+
* What should have happened?
13+
* Do you have an idea what might fix things?
14+
* How has this bug affected you?
15+
* What are you trying to accomplish?
16+
17+
## Steps to Reproduce
18+
1. Machine/OS: [insert here]
19+
2. Reproducer:
20+
```
21+
# Insert minimal example script here.
22+
```
23+
3. Output from running the script:
24+
```
25+
# Paste all output from the terminal here.
26+
```
27+
28+
## Screenshots
29+
If applicable, add screenshots to help explain your problem.

‎.github/ISSUE_TEMPLATE/discussion.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Discussion
3+
about: What do we need to talk through?
4+
title: ''
5+
labels: 'Type: Discussion'
6+
assignees: ''
7+
8+
---
9+
10+
* What do we need to talk through?
11+
* Why do we need to talk through it?
12+
* What is needed for us to consider this discussion complete?
13+
* Be sure to @mention whoever should be involved in the discussion.

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Documentation
3+
about: What's wrong with the docs?
4+
title: ''
5+
labels: 'Type: Documentation'
6+
assignees: ''
7+
8+
---
9+
10+
* What would you like to see in the documentation?
11+
* How does our current documentation not meet your needs?
12+
* How has this lack of documentation affected you?
13+
* What are you trying to accomplish?

‎.github/ISSUE_TEMPLATE/feature.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature
3+
about: What new functionality is needed?
4+
title: ''
5+
labels: 'Type: Feature'
6+
assignees: ''
7+
8+
---
9+
10+
* What feature change/addition is needed?
11+
* How does this differ from what we currently have?
12+
* Do you have suggestions on implementation?
13+
* What alternative solutions have you considered?
14+
* How has the lack of this feature affected you?
15+
* What are you trying to accomplish?
16+
* What specifically must we demonstrate to call this work complete?

‎.github/ISSUE_TEMPLATE/post-mortem.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Post-Mortem
3+
about: Let's track down the root cause of a failure
4+
title: ''
5+
labels: 'Type: Post-Mortem'
6+
assignees: ''
7+
8+
---
9+
10+
## What Went Wrong?
11+
Gather information and construct a detailed timeline of what contributed to the
12+
problem.
13+
14+
## Why Did It Go Wrong?
15+
This is not for the purpose of blame, but to educate the team such that we can
16+
learn from our mistakes.
17+
18+
## Proposed Countermeasures
19+
What changes can we implement to increase the likelihood that similar problems
20+
will not happen in the future?

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Question
3+
about: What do you need to know?
4+
title: ''
5+
labels: 'Type: Question'
6+
assignees: ''
7+
8+
---
9+
10+
## Question
11+
* What can we help you with?
12+
* What is it you're trying to accomplish?
13+
* Why do you need to do what you're trying to do?
14+
15+
## Checklist
16+
* [ ] Have you read through the [README](README.md)?
17+
* [ ] Have you searched through [our documentation][docs]?
18+
19+
[docs]: https://staged-script.readthedocs.io

‎.github/ISSUE_TEMPLATE/refactor.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Refactor
3+
about: What needs rework?
4+
title: ''
5+
labels: 'Type: Refactor'
6+
assignees: ''
7+
8+
---
9+
10+
* What needs to be cleaned up?
11+
* How would the refactored implementation differ from what we have now?
12+
* What are the potential downsides to not dealing with the technical debt now
13+
and leaving it for later?

‎.github/ISSUE_TEMPLATE/task.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Task
3+
about: What needs to be done?
4+
title: ''
5+
labels: 'Type: Task'
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
* What needs to happen?
12+
* Why does it need to happen?
13+
* How does it relate to the rest of the project?
14+
* What specifically must we demonstrate to call this work complete
15+
16+
## Tasks
17+
* [ ] First do this.
18+
* [ ] Then do that.
19+
* [ ] Also this other thing.

‎.github/pull_request_template.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!--
2+
Delete all lines in this comment except the type of issue being addressed.
3+
**Type: Bug**
4+
**Type: Documentation**
5+
**Type: Feature**
6+
**Type: Refactor**
7+
**Type: Task**
8+
-->
9+
10+
## Description
11+
<!--
12+
Insert a brief description of the changes in this PR.
13+
-->
14+
15+
## Related Issues/PRs
16+
<!--
17+
Mention any issues or pull requests that this PR is related to. E.g.,
18+
* Closes #456.
19+
* Related to #123.
20+
* Etc.
21+
-->
22+
23+
## Motivation
24+
<!--
25+
If this wasn't covered in any related issues linked above, why was this change
26+
needed? What does it do for us?
27+
-->
28+
29+
## Implementation Details
30+
<!--
31+
If appropriate, why did you implement things the way you did? What
32+
alternatives did you consider? Are there any gotchas to be aware of? How does
33+
this set us up to be in a better place in the future? Etc.
34+
-->
35+
36+
## Screenshots/Recordings
37+
<!--
38+
If applicable, visually demonstrate the behavior before and after your changes.
39+
-->
40+
41+
42+
## Testing
43+
<!--
44+
Indicate what testing you added to cover your changes, and what testing you ran
45+
to ensure your changes are working as expected.
46+
-->
47+
48+
49+
## Documentation
50+
<!--
51+
Indicate how and where you've updated the documentation to cover your changes.
52+
-->

0 commit comments

Comments
 (0)