From b32c61bf10b0608ef592f18679f4a2eebde56f21 Mon Sep 17 00:00:00 2001 From: TJ Egan Date: Fri, 3 Sep 2021 11:03:18 +0200 Subject: [PATCH] docs(issue-template): update issue templates to issue forms (#9579) Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- .../ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml | 131 ++++++++++++ .github/ISSUE_TEMPLATE/BUG_REPORT.yaml | 188 ++++++++++++++++++ .../FEATURE_REQUEST_OR_ENHANCEMENT.yaml | 71 +++++++ .github/ISSUE_TEMPLATE/QUESTION.yaml | 53 +++++ .github/ISSUE_TEMPLATE/accessibility-issue.md | 52 ----- .github/ISSUE_TEMPLATE/bug-report.md | 58 ------ .../feature-request-or-enhancement.md | 59 ------ .github/ISSUE_TEMPLATE/question.md | 24 --- 8 files changed, 443 insertions(+), 193 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yaml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.yaml delete mode 100644 .github/ISSUE_TEMPLATE/accessibility-issue.md delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request-or-enhancement.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml b/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml new file mode 100644 index 000000000000..3462f8a7b805 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml new file mode 100644 index 000000000000..b2e7556d04e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml new file mode 100644 index 000000000000..db3335361776 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yaml b/.github/ISSUE_TEMPLATE/QUESTION.yaml new file mode 100644 index 000000000000..b835fa130cf2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.yaml @@ -0,0 +1,53 @@ +name: Question ❓ +description: Usage question or discussion about Carbon components. +title: '[Question]: ' +labels: [type: question ❓] +body: + - type: markdown + attributes: + value: '## Hi there! 👋' + - type: markdown + attributes: + value: + Hope everything is going okay using projects from the Carbon Design + System. It looks like you might have a question about our work, so we + wanted to share a couple of resources that you could use if you haven't + tried them yet 🙂 + - type: markdown + attributes: + value: + If you're an IBMer, we have a couple of Slack channels available across + all IBM Workspaces. + - type: markdown + attributes: + value: '- `#carbon-design-system` for questions about the Design System.' + - type: markdown + attributes: + value: '- `#carbon-components` for questions about component styles.' + - type: markdown + attributes: + value: '- `#carbon-react` for questions about our React components' + - type: markdown + attributes: + value: + "For non-IBMer's, you can ask a question on our [Github Discussions + board](https://github.com/carbon-design-system/carbon/discussions/new) + or join [our Discord server](https://discord.gg/KAECRaWdzE) to chat with + Carbon maintainers and fellow community members." + - type: textarea + id: summary + attributes: + label: Question for Carbon + description: 'Let us know how we can help!' + 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 diff --git a/.github/ISSUE_TEMPLATE/accessibility-issue.md b/.github/ISSUE_TEMPLATE/accessibility-issue.md deleted file mode 100644 index 5688dbcf9e88..000000000000 --- a/.github/ISSUE_TEMPLATE/accessibility-issue.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: Accessibility Issue -about: Report an accessibility or usability issue -title: '' -labels: 'type: a11y ♿' -assignees: '' ---- - - - -## Environment - -> Operating system - -> Browser - -> Automated testing tool and ruleset - -> Assistive technology used to verify - -## Detailed description - -> What version of the Carbon Design System are you using? - -> What did you expect to happen? - -> What happened instead? - -> What WCAG 2.1 checkpoint does the issue violate? - -## Steps to reproduce the issue - -1. Step one -2. Step two -3. Step three -4. etc. - -> Please create a reduced test case in CodeSandbox -> -> - Style and vanilla JS: -> https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/components/examples/codesandbox -> - React: -> https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/react/examples/codesandbox - -## Additional information - -- Screenshots or code -- Notes diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 2d15dd2d06da..000000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: 'Bug Report 🐛' -about: Something isn't working as expected? Here is the right place to report. -title: '' -labels: 'type: bug 🐛' -assignees: '' ---- - - - -## What package(s) are you using? - - - -- [ ] `carbon-components` -- [ ] `carbon-components-react` - -## Detailed description - -> Describe in detail the issue you're having. - -> Is this issue related to a specific component? - -> What did you expect to happen? What happened instead? What would you like to -> see changed? - -> What browser are you working in? - -> What version of the Carbon Design System are you using? - -> What offering/product do you work on? Any pressing ship or release dates we -> should be aware of? - -## Steps to reproduce the issue - -1. Step one -2. Step two -3. Step three -4. etc. - -> Please create a reduced test case in CodeSandbox -> -> - Style and vanilla JS: -> https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/components/examples/codesandbox -> - React: -> https://codesandbox.io/s/github/carbon-design-system/carbon/tree/main/packages/react/examples/codesandbox - -## Additional information - -- Screenshots or code -- Notes diff --git a/.github/ISSUE_TEMPLATE/feature-request-or-enhancement.md b/.github/ISSUE_TEMPLATE/feature-request-or-enhancement.md deleted file mode 100644 index 0843b493a43e..000000000000 --- a/.github/ISSUE_TEMPLATE/feature-request-or-enhancement.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: 'Feature request or enhancement 💡' -about: Suggest an idea for this project -title: '' -labels: 'type: enhancement 💡' -assignees: '' ---- - -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. - -### Summary - -Please describe your request in one or two sentences. - -Clarify if you are asking for design, development, or both design and -development. - -### Justification - -Provide the business reasons for this request. - -### Desired UX and success metrics - - - -Describe the full user experience for this feature. Also define the metrics by -which we can measure success/failure for the user. - - - -### "Must have" functionality - -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. - -### Specific timeline issues / requests - - - -Do you want this work within a specific time period? Is it related to an -upcoming release? - - - -_NB: The Carbon team will try to work with your timeline, but it's not -guaranteed. The earlier you make a request in advance of a desired delivery -date, the better!_ - -### Available extra resources - -What resources do you have to assist this effort? - -_Carbon is a collaborative system. We encourage teams to build components and -submit them for integration as either add-ons or core components._ diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index bb9566f7f028..000000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Question ❓ -about: Usage question or discussion about Carbon components -title: '' -labels: 'type: question ❓' -assignees: '' ---- - -