From 39a4f7e596f2f45211d3fb461faf108c8ae6bdb0 Mon Sep 17 00:00:00 2001 From: Sergio Benitez Date: Fri, 25 Jun 2021 07:08:34 -0700 Subject: [PATCH] Update GitHub issue templates. --- .github/ISSUE_TEMPLATE.md | 55 ----------------------- .github/ISSUE_TEMPLATE/bug-report.md | 28 ++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature-request.md | 31 +++++++++++++ .github/ISSUE_TEMPLATE/suggestion.md | 26 +++++++++++ 5 files changed, 90 insertions(+), 55 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/suggestion.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index ae161595..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,55 +0,0 @@ -Hello, and thanks for opening a new issue about Rocket! - -Before opening your issue, we ask that you search through existing issues and -pull requests to see if your bug report, concern, request, or comment has -already been addressed. Ensure to search through both open and closed issues and -pull requests. If this is a question, feature request, or general comment, -please ensure that you have read the relevant sections of the documentation -before posting your issue. Finally, consider asking questions on IRC or Matrix -before opening an issue. - -If you feel confident that your issue is unique, please include the following -information, selecting the category that best describes your issue: - -## Bug Reports - -Bug reports _must_ include: - - 1. The version of Rocket you're using. Ensure it's the latest, if possible. - - 2. The operating system (distribution and version) where the issue occurs. - - 3. A brief description of the bug that includes: - * The nature of the bug. - * When the bug occurs. - * What you expected vs. what actually happened. - - 4. How you uncovered the bug. Short, reproducible tests are especially useful. - - 5. Ideas, if any, about what Rocket is doing incorrectly. - -## Questions - -Any questions _must_ include: - - 1. The version of Rocket this question is based on, if any. - - 2. What steps you've taken to answer the question yourself. - - 3. What documentation you believe should include an answer to this question. - -## Feature Requests - -Feature requests _must_ include: - - 1. Why you believe this feature is necessary. - - 2. A convincing use-case for this feature. - - 3. Why this feature can't or shouldn't exist outside of Rocket. - -## General Comments - -Feel free to comment at will. We simply ask that your comments are well -constructed and actionable. Consider whether IRC or Matrix would be a better -venue for discussion. diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..35055bb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,28 @@ +--- +name: Bug Report +about: Report behavior that deviates from specification or expectation +title: '' +labels: triage +assignees: '' +--- + +**Description** + +A clear and concise description of what the bug is. This should include links to documentation that is contradicted or an explanation of why the present functionality doesn't match your expectation. + +**To Reproduce** + +How to reproduce the bug. A fully working code example (`main.rs` + `Cargo.toml`) is preferred. + +**Expected Behavior** + +A clear and concise description of what you expected to happen. + +**Environment:** + + - OS Distribution and Kernel: [e.g. Arch Linux 4.16.13, macOS 11.2.1] + - Rocket Version: [e.g. 0.4.12, master@abf996b] + +**Additional Context** + +Add any other context about the problem here, for example, how you uncovered the bug or if you have ideas about what/where Rocket is going wrong. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..4bd24de5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Question + url: https://github.com/SergioBenitez/Rocket/discussions + about: Please ask questions or raise indefinite concerns on Dicussions diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..72401bf4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,31 @@ +--- +name: Feature Request +about: Propose a change that introduces new functionality +title: '' +labels: request +assignees: '' +--- + +**Is your feature request motivated by a concrete problem? Please describe.** + +A clear and concise description of what the problem is. Examples: + +- "I frequently want to do X, but Rocket makes it hard. It would be nice if Rocket..." +- "I want to do X but Rocket makes it impossible because..." +- "Feature Z exists, but it has these drawbacks. What if..." + +**Why this feature can't or shouldn't live outside of Rocket** + +Rocket is designed to have a small but pluggable core. Feature requests that can be implemented outside of Rocket are typically declined. Make a case for why this feature can't or shouldn't be implemented outside of Rocket. + +**Ideal Solution** + +If you have an idea for a solution, propose it with a clear and concise description. + +**Alternatives Considered** + +A clear and concise description of any alternative solutions or features you've considered. + +**Additional Context** + +Add any other context here, for example, descriptions of elegant solutions in other software. diff --git a/.github/ISSUE_TEMPLATE/suggestion.md b/.github/ISSUE_TEMPLATE/suggestion.md new file mode 100644 index 00000000..46e01706 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestion.md @@ -0,0 +1,26 @@ +--- +name: Suggestion +about: Suggest a change or improvement to existing functionality +title: '' +labels: suggestion +assignees: '' +--- + +**Existing Functionality** + +A clear and concise description of existing functionality and why it is insufficient. Examples: + +- "I frequently want to do X, but Rocket makes it hard. It would be nice if..." +- "Feature Z exists, but it has these drawbacks. What if..." + +**Suggested Changes** + +If you have a conrete idea for an improvement, propose it with a clear and concise description. + +**Alternatives Considered** + +A clear and concise description of any alternative solutions using existing features or new features you've considered. + +**Additional Context** + +Add any other context here, for example, descriptions of elegant solutions in other software.