Skip to content

Move from issue template to bug and feature request forms. #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
8 changes: 0 additions & 8 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
projects: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Detail the bad behavior and the steps required to duplicate it
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: What did you expect to happen?
description: What did you expect to happen when performing the action?
placeholder: Expected behavior
value: "Expected behavior"
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of this library are you running?
placeholder: "v0.0.0"
value:
validations:
required: true
- type: textarea
id: browsers
attributes:
label: What browsers are you seeing the problem on?
description: |
List browsers where you see the problem reported. For example:
* Mac OS 15.3.5, Chrome 130.0.1234.987
* Android 14, Firefox 133.0
* iPadOS 17.1, Safari
placeholder: 'For each browser specify 1) operating system and version 2) browser name and version'

1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Feature Request
description: Request a new feature.
title: "[FR]: "
labels: ["feature", "request", "enhancement", "triage"]
projects: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
id: feat-summary
attributes:
label: Feature Summary
description: In a few sentences or less, provide a concise description of the feature being requested.
placeholder: 'New feature that does ___; it can be used when ...'
validations:
required: true
- type: textarea
id: detailed-description
attributes:
label: Detailed description of new feature.
description: |
Please provide a detailed description of proposed feature.
- What problem would this new feature solve?
- How will this change affect users?
- Is it a modification to existing functionality? Are you requesting a new/modified function input or output? Please provide an example of what the change might look like?
placeholder: 'New feature details.'
validations:
required: true
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ jobs:
with:
node-version-file: .nvmrc
- run: npm ci
- run: npx prettier --check .
- run: npx eslint --ext .js,.ts src test
- run: npm test
Loading