Skip to content

Commit db7e891

Browse files
author
Ryan Fitzpatrick
committed
Github templates
1 parent 67dfde0 commit db7e891

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Description**
11+
A clear and concise description of what the bug is or observed behavior.
12+
13+
**Steps to reproduce**
14+
Provide a (runnable) recipe for reproducing the error.
15+
16+
**Expectation**
17+
A clear and concise description of what you expected to see.
18+
19+
**What applicable config did you use?**
20+
Config: (e.g. the yaml config file)
21+
22+
**Relevant Environment Information**
23+
Version: (e.g., `v0.0.1`, `2bef20a`, etc.)
24+
OS: (e.g., "Ubuntu 20.04")
25+
Compiler (if manually compiled): (e.g., "openJDK 1.8.0_252")
26+
27+
**Additional context**
28+
Add any other context about the problem here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
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 [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Description:**
2+
3+
< Describe what is being changed or added.
4+
Ex. Bug fix - Describe the bug and how this fixes it.
5+
Ex. Feature addition - Describe what this provides and why. >
6+
7+
**Existing Issue(s):**
8+
9+
< Link any applicable issues. >
10+
11+
**Testing:**
12+
13+
< Describe what testing was performed and any tests were added. >
14+
15+
**Documentation:**
16+
17+
< Describe the documentation added.
18+
Please be sure to modify relevant existing documentation if needed. >
19+
20+
**Outstanding items:**
21+
22+
< Anything that these changes are intentionally missing
23+
that will be needed or can be helpful in the future. >

0 commit comments

Comments
 (0)