Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Feature Request
description: Request a new feature
title: ""
labels: ["triage"]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would triage look like for a feature request? Initial evaluation if it makes sense?

type: "feature"
body:
- type: markdown
attributes:
value: |
## Thanks for your input on enhancements to Capacitor!
Before creating a feature request, be sure to keep the following points in mind:
- Search existing feature requests to make sure there isn't already an existing request.
- Make sure this is the correct project for your request. If the request is related to a plugin or Capacitor core, create the request on that relevant GitHub project instead.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as comment #7 (comment)

- Make sure feature requests are relevant to the goals of the project. If you are unsure, feel free to chat with us in [discussions](https://github.com/ionic-team/capacitor/discussions).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any existing docs on GitHub that could be relevant to point people to to better understand what could be the goals of the project? I guess it depends on the project, so maybe not.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another thing that might be worth mentioning is to try to provide as much information as possible. Ambiguous or unclear feature requests with like just 1 or 2 sentences are unlikely to be picked up by the team. Maybe this is obvious, but maybe it could be made explicit?

- type: textarea
id: description
attributes:
label: Feature Description
description: "Describe the feature you would like to see."
validations:
required: true
Comment on lines +17 to +21

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The question I made at #7 (comment) can also apply here.

- type: textarea
id: implementation
attributes:
label: Potential Implementation
description: "Describe any potential implementation or preferred solution for this feature, or examples of solutions in the wild."
validations:
required: false
- type: checkboxes
id: supported-platforms
attributes:
label: Supported Platforms
description: "Check the platforms this feature request is relevant to."
options:
- label: iOS
required: false
- label: Android
required: false
- label: Web
required: false
Comment on lines +32 to +40

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment I made at #7 (comment) can also apply here.

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: "Describe some alternatives, if any."
validations:
required: false

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking if some of these fields should be required or not. If they're not required, it increases the chances of the feature requests missing relevant information? But possibly you already thought about this so would like to get your input.

- type: textarea
id: notes
attributes:
label: Notes / Comments
description: "Include any other information about the feature request here, for example, potential use cases, benefits, etc."
validations:
required: false