Skip to content

Commit

Permalink
Add GitHub Issue Templates (#183)
Browse files Browse the repository at this point in the history
  • Loading branch information
danforbes committed Nov 2, 2020
1 parent 8accbe9 commit 3b3d4de
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/ask-a-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Ask a Question
about: Ask a question about this project.
title: ""
labels: question
assignees: ""
---

**Question**

_Please include information such as the following: is your question to clarify an existing resource
or are you asking about something new? what are you trying to accomplish? where have you looked for
answers?_
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/report-a-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Report a Bug
about: Report a problem with this project.
title: ""
labels: bug
assignees: ""
---

**Description**

_Tell us what happened. In particular, tell us how and why you are using this project, and describe
the bug that you encountered. Ideally, provide a link to your project's GitHub repository. Please
note that we are not able to support all conceivable use cases, but the more information you are
able to provide the more equipped we will be to help._

**Steps to Reproduce**

_Replace the example steps below with actual steps to reproduce the bug you're reporting._

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected vs. Actual Behavior**

_What did you expect to happen after you followed the steps you described in the last section? What
actually happened?_

**Environment**

_Describe the environment in which you encountered this bug. Use the list below as a starting point
and add additional information if you think it's relevant._

- Operating system:
- Project version/tag:
- Rust version (run `rustup show`):

**Logs, Errors or Screenshots**

_Please provide the text of any logs or errors that you experienced; if applicable, provide
screenshots to help illustrate the problem._

**Additional Information**

_Please add any other details that you think may help us solve your problem._
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/suggest-a-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Suggest a Feature
about: Suggest a new feature or an improvement to an existing feature for this project.
title: ""
labels: enhancement
assignees: ""
---

**Motivation**

_Describe the need or frustration that motivated you to make this suggestion. Please note that the
goal of this project is to provide common reusable utilities, so please take care when suggesting
features that may be specific to a particular use case._

**Suggested Solution**

_Describe your suggested solution to the need or frustration that you are experiencing._

**Alternatives**

_Describe any alternative solutions or features you considered and why you believe your suggested
solution is preferable._

**Additional Information**

_Provide any additional information that you believe may help us evaluate your suggestion._

0 comments on commit 3b3d4de

Please sign in to comment.