Skip to content

Commit

Permalink
chore: Convert the feature request template to an issue form (#3036)
Browse files Browse the repository at this point in the history
Similar to: #3027

This PR is doing:
- Adding a new issue form to replace the template found here:
https://github.com/flame-engine/flame/blob/main/.github/ISSUE_TEMPLATE/2_feature.md
- Also _deletes_ the template, so we don't see duplicates when a user
comes to create a feature request.

Proposed new form looks like:
<img width="957" alt="image"
src="https://github.com/flame-engine/flame/assets/13091188/86dcbe60-d0fb-4f77-ab97-8895e3b69e8f">

I took some leniences in design decisions with making, which happy to
change if needed:
- The problem _and_ proposal text areas **required**
- Turned the "are you interested in doing a PR?" into a checkbox.
  • Loading branch information
anleac committed Feb 14, 2024
1 parent 78380b9 commit d2e62bd
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 21 deletions.
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/2_feature.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature request
description: Suggest a new feature for Flame.
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
When suggesting a feature, please read this complete form and fill in all the questions in order to get a better response!
- type: textarea
id: problem-to-solve
attributes:
label: Problem to solve
description: Which problem would be solved with this feature?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposal
description: What do you propose as a solution? Add as much information as you can!
validations:
required: true
- type: textarea
id: more-information
attributes:
label: More information
description: Do you have any other useful information about this feature report? Please write it down here. Possible helpful information are references to other sites/repositories.
- type: checkboxes
id: other
attributes:
label: Other
options:
- label: Are you interested in working on a PR for this?

0 comments on commit d2e62bd

Please sign in to comment.