Skip to content

Commit

Permalink
Auto merge of #9970 - ehuss:issue-template-forms, r=alexcrichton
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bors committed Oct 12, 2021
2 parents 2e6a4e1 + 0008f68 commit ad85ec9
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 79 deletions.
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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.
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/tracking_issue.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/tracking_issue.yml
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit ad85ec9

Please sign in to comment.