-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(issue-template): update issue templates to issue forms (#9579)
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
- Loading branch information
1 parent
8ce0b4c
commit b32c61b
Showing
8 changed files
with
443 additions
and
193 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
name: Accessibility Issue ♿ | ||
description: Report an accessibility or usability issue. | ||
title: '[a11y]: ' | ||
labels: [type: a11y ♿] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: '## Welcome!' | ||
- type: markdown | ||
attributes: | ||
value: | ||
Thanks for taking the time to fill out this accessibility report. IBM | ||
firmly believes that web and software experiences should be accessible | ||
for everyone. Carbon is committed to following and complying with | ||
accessibility best practices. | ||
- type: dropdown | ||
id: package | ||
attributes: | ||
label: Package | ||
description: Which package(s) are you using? | ||
multiple: true | ||
options: | ||
- 'carbon-components' | ||
- 'carbon-components-react' | ||
- '@carbon/colors' | ||
- '@carbon/elements' | ||
- '@carbon/grid' | ||
- '@carbon/icons' | ||
- '@carbon/icons-react' | ||
- '@carbon/icons-vue' | ||
- '@carbon/layout' | ||
- '@carbon/motion' | ||
- '@carbon/pictograms' | ||
- '@carbon/pictograms-react' | ||
- '@carbon/themes' | ||
- '@carbon/type' | ||
- '@carbon/upgrade' | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browser | ||
attributes: | ||
label: Browser | ||
description: Which browser(s) are you experiencing the issue? | ||
multiple: true | ||
options: | ||
- Chrome | ||
- Safari | ||
- Firefox | ||
- Edge | ||
- type: dropdown | ||
id: os | ||
attributes: | ||
label: Operating System | ||
description: Which operating system are you using? | ||
multiple: true | ||
options: | ||
- Windows | ||
- MacOS | ||
- Other | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Package version | ||
description: 'Which version(s) are you using?' | ||
placeholder: e.g. v10.42.0 | ||
validations: | ||
required: true | ||
- type: input | ||
id: tool | ||
attributes: | ||
label: Automated testing tool and ruleset | ||
description: 'Which tool and ruleset uncovered the issue?' | ||
placeholder: | ||
e.g. IBM Equal Access Accessibility Checker - Latest Deployment | ||
validations: | ||
required: true | ||
- type: input | ||
id: technology | ||
attributes: | ||
label: Assistive technology | ||
description: 'Did you experience the issue using an assistive technology?' | ||
placeholder: e.g. JAWS, MacOS VoiceOver | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: | ||
"Tell us more about the accessibility issue that you're experiencing" | ||
placeholder: What did you expect to happen? What happened instead? | ||
validations: | ||
required: true | ||
- type: input | ||
id: wcag | ||
attributes: | ||
label: WCAG 2.1 Violation | ||
description: 'Does this violate a specific WCAG 2.1 checkpoint?' | ||
placeholder: e.g Success Criterion 1.4.3 Contrast (Minimum) | ||
- type: input | ||
id: example-url | ||
attributes: | ||
label: CodeSandbox example | ||
description: | ||
'Use our | ||
[CodeSandbox](https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/react/examples/codesandbox) | ||
to re-create the issue' | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: Steps to reproduce | ||
description: | ||
'How do we reproduce the accessibility violation you described using the | ||
CodeSandbox link above?' | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: Please confirm the following | ||
options: | ||
- label: | ||
I agree to follow this project's [Code of | ||
Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) | ||
required: true | ||
- label: | ||
I checked the [current | ||
issues](https://github.com/carbon-design-system/carbon/issues) for | ||
duplicate problems |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
name: Bug report 🐛 | ||
description: | ||
Something not working as expected? This is the place to report your issue. | ||
title: '[Bug]: ' | ||
labels: [tyname: Bug report 🐛 | ||
description: | ||
Something not working as expected? This is the place to report your | ||
issue. | ||
title: '[Bug]: ' | ||
labels: [type: bug 🐛] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: "## Welcome!" | ||
- type: markdown | ||
attributes: | ||
value: Thanks for taking the time to fill out this bug report. | ||
- type: dropdown | ||
id: package | ||
attributes: | ||
label: Package | ||
description: Which package(s) are you using? | ||
multiple: true | ||
options: | ||
- 'carbon-components' | ||
- 'carbon-components-react' | ||
- '@carbon/colors' | ||
- '@carbon/elements' | ||
- '@carbon/grid' | ||
- '@carbon/icons' | ||
- '@carbon/icons-react' | ||
- '@carbon/icons-vue' | ||
- '@carbon/layout' | ||
- '@carbon/motion' | ||
- '@carbon/pictograms' | ||
- '@carbon/pictograms-react' | ||
- '@carbon/themes' | ||
- '@carbon/type' | ||
- '@carbon/upgrade' | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browser | ||
attributes: | ||
label: Browser | ||
description: Which browser(s) are you experiencing the issue? | ||
multiple: true | ||
options: | ||
- Chrome | ||
- Safari | ||
- Firefox | ||
- Edge | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Package version | ||
description: | ||
'Which version(s) are you using?' | ||
placeholder: e.g. v10.42.0 | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: "Tell us more about the problem that you're running into" | ||
placeholder: What did you see? What did you expect to see? | ||
validations: | ||
required: true | ||
- type: input | ||
id: example-url | ||
attributes: | ||
label: CodeSandbox example | ||
description: | ||
'Use our | ||
[CodeSandbox](https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/react/examples/codesandbox) | ||
to re-create the issue' | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: Steps to reproduce | ||
description: "How do we reproduce the error you described using the CodeSandbox link above?" | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: Please confirm the following | ||
options: | ||
- label: I agree to follow this project's [Code of Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) | ||
required: true | ||
- label: I checked the [current issues](https://github.com/carbon-design-system/carbon/issues) for duplicate problems | ||
|
||
pe: bug 🐛] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: '## Welcome!' | ||
- type: markdown | ||
attributes: | ||
value: Thanks for taking the time to fill out this bug report 💙 | ||
- type: dropdown | ||
id: package | ||
attributes: | ||
label: Package | ||
description: Which package(s) are you using? | ||
multiple: true | ||
options: | ||
- 'carbon-components' | ||
- 'carbon-components-react' | ||
- '@carbon/colors' | ||
- '@carbon/elements' | ||
- '@carbon/grid' | ||
- '@carbon/icons' | ||
- '@carbon/icons-react' | ||
- '@carbon/icons-vue' | ||
- '@carbon/layout' | ||
- '@carbon/motion' | ||
- '@carbon/pictograms' | ||
- '@carbon/pictograms-react' | ||
- '@carbon/themes' | ||
- '@carbon/type' | ||
- '@carbon/upgrade' | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: browser | ||
attributes: | ||
label: Browser | ||
description: Which browser(s) are you experiencing the issue? | ||
multiple: true | ||
options: | ||
- Chrome | ||
- Safari | ||
- Firefox | ||
- Edge | ||
- type: input | ||
id: version | ||
attributes: | ||
label: Package version | ||
description: 'Which version(s) are you using?' | ||
placeholder: e.g. v10.42.0 | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: "Tell us more about the problem that you're running into" | ||
placeholder: What did you see? What did you expect to see? | ||
validations: | ||
required: true | ||
- type: input | ||
id: example-url | ||
attributes: | ||
label: CodeSandbox example | ||
description: | ||
'Use our | ||
[CodeSandbox](https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/react/examples/codesandbox) | ||
to re-create the issue' | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: Steps to reproduce | ||
description: | ||
'How do we reproduce the error you described using the CodeSandbox link | ||
above?' | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: Please confirm the following | ||
options: | ||
- label: | ||
I agree to follow this project's [Code of | ||
Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) | ||
required: true | ||
- label: | ||
I checked the [current | ||
issues](https://github.com/carbon-design-system/carbon/issues) for | ||
duplicate problems |
71 changes: 71 additions & 0 deletions
71
.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
name: Feature request or enhancement 💡 | ||
description: Suggest an idea for this project. | ||
title: '[Feature Request]: ' | ||
labels: [type: enhancement 💡] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: '## Welcome!' | ||
- type: markdown | ||
attributes: | ||
value: | ||
Use this template if you want to request a new feature, or a change to | ||
an existing feature. If you are reporting a bug or problem, please use | ||
the bug template instead. | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: Summary | ||
description: | ||
'Please describe your request in one or two sentences. Clarify if you | ||
are asking for design, development, or both design and development.' | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: justification | ||
attributes: | ||
label: Justification | ||
description: 'Provide the business reasons for this request.' | ||
- type: textarea | ||
id: metrics | ||
attributes: | ||
label: Desired UX and success metrics | ||
description: | ||
'Describe the full user experience for this feature. Also define the | ||
metrics by which we can measure success/failure for the user.' | ||
- type: textarea | ||
id: functionality | ||
attributes: | ||
label: Required functionality | ||
description: | ||
'Highlight any must have needs and functionality for the request. This | ||
should not be a full list of functionality; the Carbon team will work | ||
with you to define functionality based on the desired UX.' | ||
- type: textarea | ||
id: timeline | ||
attributes: | ||
label: Specific timeline issues / requests | ||
description: | ||
'Do you want this work within a specific time period? Is it related to | ||
an upcoming release?' | ||
- type: input | ||
id: resources | ||
attributes: | ||
label: Available extra resources | ||
description: 'What resources do you have to assist this effort?' | ||
- type: markdown | ||
attributes: | ||
value: | ||
'_Carbon is a collaborative system. We encourage teams to build | ||
components and submit them for integration as either add-ons or core | ||
components._' | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: Please confirm the following | ||
options: | ||
- label: | ||
I agree to follow this project's [Code of | ||
Conduct](https://github.com/carbon-design-system/carbon/blob/f555616971a03fd454c0f4daea184adf41fff05b/.github/CODE_OF_CONDUCT.md) | ||
required: true |
Oops, something went wrong.