Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
Add blank issue, feature request, and bug report issue templates.
  • Loading branch information
kyleecodes authored Sep 5, 2023
1 parent d71c9ef commit 69a10f8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/blank-issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Blank Issue Template
about: The standard issue template for Chayn
title: ''
labels: ''
assignees: ''

---

### Overview
Clearly state the purpose of this issue, ideally in 2 sentences or less.
For example: *_We need to do X for Y reason._*

### Action Items
List research to be done or the steps to be completed.
Note: If the steps can be divided into tasks for more than one person, we recommend dividing it up into separate issues, or assigning it as a pair programming task.

### Resources
Provide links to resources that may help solve or better understand with this issue. This can include external sites with solutions, documentation, etc.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest an idea
title: ''
labels: ''
assignees: ''

---

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

### Describe a solution:
If applicable, please a detailed description of what you want to see or build to fix the problem. Include who wants it (e.g. yourself, a survivor, volunteer, developer, organization, etc.), and what value you think this will bring.

### Additional context and resources:
Add any other context, documents, links, screenshots about the feature request here. Please be detailed!

0 comments on commit 69a10f8

Please sign in to comment.