Auto merge of #9970 - ehuss:issue-template-forms, r=alexcrichton

Use forms for issue templates.

This switches the GitHub issue templates to use the new forms functionality.  This makes it so that the user doesn't need to fuss with editing the placeholder text, and instead can just start writing text.

I'm mostly just curious how this will work out. If people have trouble with it, or there are complaints, it can be reverted pretty easily.
This commit is contained in:
bors 2021-10-12 15:11:01 +00:00
commit ad85ec9fc0
6 changed files with 120 additions and 79 deletions

View File

@ -1,28 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
labels: C-bug
---
<!-- Thanks for filing a 🐛 bug report 😄! -->
**Problem**
<!-- A clear and concise description of what the bug is. -->
<!-- including what currently happens and what you expected to happen. -->
**Steps**
<!-- The steps to reproduce the bug. -->
1.
2.
3.
**Possible Solution(s)**
<!-- Not obligatory, but suggest a fix/reason for the bug, -->
<!-- or ideas how to implement the addition or change -->
**Notes**
Output of `cargo version --verbose`:
<!-- Also, any additional context or information you feel may be relevant to the issue. -->
<!-- (e.g rust version, OS platform/distribution/version, target toolchain(s), release channel.. -->

43
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -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

View File

@ -1,16 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
labels: C-feature-request
---
<!-- Thanks for filing a 🙋 feature request 😄! -->
**Describe the problem you are trying to solve**
<!-- A clear and concise description of the problem this feature request is trying to solve. -->
**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. -->
**Notes**
<!-- Any additional context or information you feel may be relevant to the issue. -->

View File

@ -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.

View File

@ -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
---
<!--
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.
-->
**Summary**
RFC: [#NNNN](https://github.com/rust-lang/rfcs/pull/NNNN) <!-- If this is an RFC -->
Original issue: #NNNN <!-- if there is a related issue that spawned this feature -->
Implementation: #NNNN <!-- link to the PR that implemented this feature if applicable -->
Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#my-feature
<!-- Write a very brief summary of the feature here. -->
**Unresolved issues**
* [ ] Make a list of any known implementation or design issues.
**Future extensions**
<!-- An optional section where you can mention where the feature may be extended in the future, but is explicitly not intended to address. -->
**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.

View File

@ -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) <!-- If this is an RFC -->
Original issue: #NNNN <!-- if there is a related issue that spawned this feature -->
Implementation: #NNNN <!-- link to the PR that implemented this feature if applicable -->
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.