From 7a3d8d6f3baaaa36bab51110ad9f4249405be693 Mon Sep 17 00:00:00 2001 From: Dan Forbes Date: Wed, 19 Aug 2020 17:47:10 -0700 Subject: [PATCH] Create Issue templates (#73) * Create Issue templates - Report a Bug - Suggest a Feature - Ask a Question --- .github/ISSUE_TEMPLATE/ask-a-question.md | 13 ++++++ .github/ISSUE_TEMPLATE/report-a-bug.md | 46 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/suggest-a-feature.md | 26 ++++++++++++ 3 files changed, 85 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/ask-a-question.md create mode 100644 .github/ISSUE_TEMPLATE/report-a-bug.md create mode 100644 .github/ISSUE_TEMPLATE/suggest-a-feature.md diff --git a/.github/ISSUE_TEMPLATE/ask-a-question.md b/.github/ISSUE_TEMPLATE/ask-a-question.md new file mode 100644 index 0000000..7687625 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ask-a-question.md @@ -0,0 +1,13 @@ +--- +name: Ask a Question +about: Ask a question about this template. +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?_ diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.md b/.github/ISSUE_TEMPLATE/report-a-bug.md new file mode 100644 index 0000000..31b2ea8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-a-bug.md @@ -0,0 +1,46 @@ +--- +name: Report a Bug +about: Report a problem with this template. +title: "" +labels: bug +assignees: "" +--- + +**Description** + +_Tell us what happened. In particular, be specific about any changes you made to this template. +Ideally, provide a link to your project's GitHub repository. Please note that we are not able to +support all conceivable changes to this template project, 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: +- Template 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._ diff --git a/.github/ISSUE_TEMPLATE/suggest-a-feature.md b/.github/ISSUE_TEMPLATE/suggest-a-feature.md new file mode 100644 index 0000000..60c7678 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggest-a-feature.md @@ -0,0 +1,26 @@ +--- +name: Suggest a Feature +about: Suggest a new feature or an improvement to an existing feature for this template. +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 a general-purpose template project, 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._