Skip to content

Commit

Permalink
Github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Fitzpatrick committed Aug 19, 2020
1 parent d23263b commit 727ac72
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Description**
A clear and concise description of what the bug is or observed behavior.

**Steps to reproduce**
Provide a (runnable) recipe for reproducing the error.

**Expectation**
A clear and concise description of what you expected to see.

**What applicable config did you use?**
Config: (e.g. the yaml config file)

**Relevant Environment Information**
Version: (e.g., `v0.0.1`, `2bef20a`, etc.)
OS: (e.g., "Ubuntu 20.04")
Compiler (if manually compiled): (e.g., "openJDK 1.8.0_252")

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
23 changes: 23 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Description:**

< Describe what is being changed or added.
Ex. Bug fix - Describe the bug and how this fixes it.
Ex. Feature addition - Describe what this provides and why. >

**Existing Issue(s):**

< Link any applicable issues. >

**Testing:**

< Describe what testing was performed and any tests were added. >

**Documentation:**

< Describe the documentation added.
Please be sure to modify relevant existing documentation if needed. >

**Outstanding items:**

< Anything that these changes are intentionally missing
that will be needed or can be helpful in the future. >

0 comments on commit 727ac72

Please sign in to comment.