Skip to content

Commit

Permalink
chore(github-forms): switch to github forms (#24)
Browse files Browse the repository at this point in the history
### Related Ticket(s)

No related issue

### Description

This is a housekeeping PR to upgrade our issue templates to use Github forms.

### Changelog

**New**

- Github issue forms

**Removed**

- Github markdown issue templates
  • Loading branch information
jeffchew authored Nov 1, 2021
1 parent 891b7f5 commit 0195cdb
Show file tree
Hide file tree
Showing 8 changed files with 275 additions and 132 deletions.
43 changes: 0 additions & 43 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: Bug report 🐛
description:
Something isn't working as expected? Here is the right place to report.
title: '[YOUR TITLE]: Brief description'
assignees:
- jeffchew,ljcarot,shixiedesign,RobertaJHahn
labels: ['bug']
body:
- type: markdown
attributes:
value: '## Bug report 🐛'
- type: markdown
attributes:
value: 'Use the form below to report any bugs you find. Feel free to leave blank any sections that aren’t relevant but try to include as much detail as possible. The more details we have, the faster we can respond.'
- type: textarea
id: description
attributes:
label: Description
description: "What did you expect to happen? What happened instead?"
validations:
required: true
- type: textarea
id: components
attributes:
label: Page(s)/component(s) impacted
description: "Page(s) or component(s) impacted? Please include screenshots, or code and relevant URLs."
validations:
required: true
- type: dropdown
id: browser
attributes:
label: Browser
description: "What browser(s) are you working in?"
multiple: true
options:
- Chrome
- Safari
- Firefox
- Microsoft Edge
- type: input
id: version
attributes:
label: Carbon for IBM.com version
description: "What version of Carbon for IBM.com are you using?"
placeholder: e.g. v1.24.0
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
options:
- 'Severity 1 = The design is broken in a critical way that blocks users from completing tasks or damages the brand. Affects major functionality, no workaround.'
- 'Severity 2 = Aspects of design is broken, and impedes users in a significant way, but there is a way to complete their tasks. Affects major functionality, has a workaround.'
- 'Severity 3 = The problem is visible or noticeable to users but does not impede the usability or functionality. Affects minor functionality, has a workaround.'
- 'Severity 4 = The problem is not visible to or noticeable to an average user. Affects minor functionality, no workaround needed.'
validations:
required: true
- type: input
id: application
attributes:
label: Application/website
description: "What application/website do you work on?"
validations:
required: true
- type: input
id: example-url
attributes:
label: URL example
description:
'If possible, please provide a URL for our team to review.'
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: "Steps to reproduce the issue (if applicable)"
- type: textarea
id: release-date
attributes:
label: "Release date (if applicable)"
validations:
required: false
- 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-for-ibm-dotcom-web-components-template/blob/master/.github/CODE_OF_CONDUCT.md)
required: true
- label:
I checked the [current
issues](https://github.com/carbon-design-system/carbon-for-ibm-dotcom-web-components-template/issues) for
duplicate issues
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Feature Request 💡
description:
Suggest a new idea for the project.
title: '[YOUR TITLE]: Brief description'
assignees:
- jeffchew,ljcarot,shixiedesign,RobertaJHahn
labels: ['Feature request']
body:
- type: markdown
attributes:
value: '## Feature Request 💡'
- type: textarea
id: problem
attributes:
label: The problem
description: "Provide a clear and concise description of what the problem this new feature is trying to solve. (For example, I find it frustrating when...)"
validations:
required: true
- type: textarea
id: solution
attributes:
label: The solution
description: "Provide a clear and concise description of what you would like to happen instead."
validations:
required: true
- type: input
id: application
attributes:
label: Application/website
description: "What application/website do you work on?"
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Business priority
options:
- 'High Priority = pressing release'
- 'Medium Priority = upcoming release but is not pressing'
- 'Low Priority = release date is not dependent on fix or not upcoming'
validations:
required: true
- type: textarea
id: time-frame
attributes:
label: "What time frame would this ideally be needed by (if applicable)"
validations:
required: false
- type: textarea
id: user-research
attributes:
label: Examples
description: Provide sample content, references, or audits of solutions solving the same problem in other applications/websites.
- 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-for-ibm-dotcom-web-components-template/blob/master/.github/CODE_OF_CONDUCT.md)
required: true
- label:
I checked the [current
issues](https://github.com/carbon-design-system/carbon-for-ibm-dotcom-web-components-template/issues) for
duplicate issues
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Question 🤔
description:
Usage question or discussion about the Carbon for IBM.com Web Components Template.
title: '[YOUR TITLE]: Brief description'
assignees:
- jeffchew,ljcarot,shixiedesign,RobertaJHahn
labels: ['question']
body:
- type: markdown
attributes:
value: '## Question 🤔'
- type: markdown
attributes:
value: "Hi there! 👋 Hope everything is going okay using projects from Carbon for IBM.com. It looks like you might have a question about our work, so we wanted to share a couple 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-for-ibm-dotcom for questions about Carbon for IBM.com
- #carbon-design-system for questions about the Carbon Design System"
- type: markdown
attributes:
value: "If these resources don't work out, help us out by filling out a couple of details below!"
- type: textarea
id: summary
attributes:
label: Summary
validations:
required: true
- type: textarea
id: relevant-information
attributes:
label: Relevant information
- type: textarea
id: organization
attributes:
label: Name and organization
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-for-ibm-dotcom-web-components-template/blob/master/.github/CODE_OF_CONDUCT.md)
required: true
- label:
I checked the [current
issues](https://github.com/carbon-design-system/carbon-for-ibm-dotcom-web-components-template/issues) for
duplicate issues
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/user_story.md

This file was deleted.

Loading

0 comments on commit 0195cdb

Please sign in to comment.