Skip to content

Commit

Permalink
Add feature requests github template
Browse files Browse the repository at this point in the history
  • Loading branch information
TheAngryByrd committed Oct 6, 2023
1 parent fe7a26a commit fbd55ed
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,15 @@ body:
- type: input
attributes:
label: Version
description: Which version of the package does this bug affect? Make sure you're not using an outdated version.
description: |
Which version of the package does this bug affect? Make sure you're not using an outdated version.
- If you are using VSCode, the version of Ionide can be used. You can can find this by going to `View -> Extensions -> Ionide for F#`. It will be displayed next to the name at the top.
- If you are using the tool directly, you can find the version by running `dotnet fsautocomplete --version` in your terminal.
placeholder: v1.0.0
validations:
required: true

- type: input
- type: textarea
attributes:
label: Dotnet Info
description: What is the output of `dotnet --info`?
Expand All @@ -35,7 +38,7 @@ body:
Minimum steps required to reproduce the bug, including prerequisites, code snippets, or other relevant items.
The information provided in this field must be readily actionable, meaning that anyone should be able to reproduce the bug by following these steps.
If the reproduction steps are too complex to fit in this field, please provide a link to a repository instead.
If you don't provide actionable reproduction steps, your issue won't be investigated.
⚠️ If you don't provide actionable reproduction steps, your issue won't be investigated. ⚠️
placeholder: |
- Step 1
- Step 2
Expand Down
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: ✨ Feature request
description: Request a new feature.
labels: [enhancement]

body:
- type: markdown
attributes:
value: |
- Avoid generic or vague titles such as "Something's not working" or "A couple of problems" — be as descriptive as possible.
- Keep your issue focused on one single problem. If you have multiple feature requests, please create a separate issue for each of them.
- Issues should represent **complete and actionable** work items. If you are unsure about something or have a question, please start a [discussion](https://github.com/fsharp/FsAutoComplete/discussions/new/choose) instead.
- Remember that **FsAutocomplete** is an open-source project funded by the community contributions and free time.
___
- type: textarea
attributes:
label: Details
description: Clear and thorough explanation of the feature you have in mind.
validations:
required: true

- type: checkboxes
attributes:
label: Checklist
description: Quick list of checks to ensure that everything is in order.
options:
- label: I have looked through existing issues to make sure that this feature has not been requested before
required: true
- label: I have provided a descriptive title for this issue
required: true
- label: I am aware that even valid feature requests may be rejected if they do not align with the project's goals
required: true
- label: I or my company would be willing to contribute this fix
required: false

0 comments on commit fbd55ed

Please sign in to comment.