From 0008f68f4fbeb07d70df818fded6599d62ae9c41 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Mon, 11 Oct 2021 13:31:58 -0700 Subject: [PATCH] Use forms for issue templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 28 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 43 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ------- .github/ISSUE_TEMPLATE/feature_request.yml | 27 ++++++++++++ .github/ISSUE_TEMPLATE/tracking_issue.md | 35 --------------- .github/ISSUE_TEMPLATE/tracking_issue.yml | 50 ++++++++++++++++++++++ 6 files changed, 120 insertions(+), 79 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/tracking_issue.md create mode 100644 .github/ISSUE_TEMPLATE/tracking_issue.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b7554b8f428..00000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -labels: C-bug ---- - - - -**Problem** - - - -**Steps** - -1. -2. -3. - -**Possible Solution(s)** - - - -**Notes** - -Output of `cargo version --verbose`: - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000000..f465e124037 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,43 @@ +name: Bug Report +description: Create a report to help us improve +labels: ["C-bug"] +body: + - type: markdown + attributes: + value: Thanks for filing a 🐛 bug report 😄! + - type: textarea + id: problem + attributes: + label: Problem + description: > + Please provide a clear and concise description of what the bug is, + including what currently happens and what you expected to happen. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps + description: Please list the steps to reproduce the bug. + placeholder: | + 1. + 2. + 3. + - type: textarea + id: possible-solutions + attributes: + label: Possible Solution(s) + description: > + Not obligatory, but suggest a fix/reason for the bug, + or ideas how to implement the addition or change. + - type: textarea + id: notes + attributes: + label: Notes + description: Provide any additional notes that might be helpful. + - type: textarea + id: version + attributes: + label: Version + description: Please paste the output of running `cargo version --verbose`. + render: text diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 68ca4a1b873..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -labels: C-feature-request ---- - - - -**Describe the problem you are trying to solve** - - -**Describe the solution you'd like** - - -**Notes** - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000000..a82498fda44 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,27 @@ +name: Feature Request +description: Suggest an idea for enhancing Cargo +labels: ["C-feature-request"] +body: + - type: markdown + attributes: + value: Thanks for filing a 🙋 feature request 😄! + - type: textarea + id: problem + attributes: + label: Problem + description: > + Please provide a clear description of your use case and the problem + this feature request is trying to solve. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: > + Please provide a clear and concise description of what you want to happen. + - type: textarea + id: notes + attributes: + label: Notes + description: Provide any additional context or information that might be helpful. diff --git a/.github/ISSUE_TEMPLATE/tracking_issue.md b/.github/ISSUE_TEMPLATE/tracking_issue.md deleted file mode 100644 index f1809821d71..00000000000 --- a/.github/ISSUE_TEMPLATE/tracking_issue.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Tracking Issue -about: A tracking issue for an accepted feature or RFC in Cargo. -title: Tracking Issue for XXX -labels: C-tracking-issue ---- - - -**Summary** - -RFC: [#NNNN](https://github.com/rust-lang/rfcs/pull/NNNN) -Original issue: #NNNN -Implementation: #NNNN -Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#my-feature - - - -**Unresolved issues** - -* [ ] Make a list of any known implementation or design issues. - -**Future extensions** - - - -**About tracking issues** - -Tracking issues are used to record the overall progress of implementation. -They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions. -A tracking issue is however *not* meant for large scale discussion, questions, or bug reports about a feature. -Instead, open a dedicated issue for the specific matter and add the relevant feature gate label. diff --git a/.github/ISSUE_TEMPLATE/tracking_issue.yml b/.github/ISSUE_TEMPLATE/tracking_issue.yml new file mode 100644 index 00000000000..d687db4e55e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tracking_issue.yml @@ -0,0 +1,50 @@ +name: Tracking Issue +description: A tracking issue for an accepted feature or RFC in Cargo. +title: "Tracking Issue for _FEATURE_NAME_" +labels: ["C-tracking-issue"] +body: + - type: markdown + attributes: + value: > + Thank you for creating a tracking issue! Tracking issues are for tracking an + accepted feature or RFC from implementation to stabilization. Please do not + file a tracking issue until the feature or RFC has been approved. + - type: textarea + id: summary + attributes: + label: Summary + description: Please provide a very brief summary of the feature. + value: | + RFC: [#NNNN](https://github.com/rust-lang/rfcs/pull/NNNN) + Original issue: #NNNN + Implementation: #NNNN + Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#my-feature + + Please enter a short, one-sentence description here. + validations: + required: true + - type: textarea + id: unresolved + attributes: + label: Unresolved Issues + description: List issues that have not yet been resolved. + placeholder: | + * [ ] Make a list of any known implementation or design issues. + - type: textarea + id: future + attributes: + label: Future Extensions + description: > + An optional section where you can mention where the feature may be + extended in the future, but is explicitly not intended to + address. + - type: textarea + id: about + attributes: + label: About tracking issues + description: Please include this notice in the issue. + value: | + Tracking issues are used to record the overall progress of implementation. + They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions. + A tracking issue is however *not* meant for large scale discussion, questions, or bug reports about a feature. + Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.