Skip to content

Commit

Permalink
Update issue templates (#3374)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwooding authored Sep 11, 2024
1 parent 6e3b052 commit 4987cca
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 135 deletions.
69 changes: 43 additions & 26 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug report 🪲
description: Report bugs in our code.
description: Something is broken and you have a reproduction? Let us know so we can fix it!
labels:
- "type: bug 🪲"
- "status: awaiting triage"
Expand All @@ -8,12 +8,41 @@ body:
attributes:
value: |
### ⚠️ Warning
This is a public repository, so **please do not include any internal company code or sensitive data** in your bug report.
This is a public repository, so **please do not include any internal company code or sensitive data** in your bug report. If you are an internal JPM user, please also look at your [internal options](go/salt-ds-support).
- type: markdown
attributes:
value: Thanks for taking the time to report a bug! Before you start, please check that your issue isn’t already reported by searching the [existing issues](https://github.com/jpmorganchase/salt-ds/issues?q=sort%3Aupdated-desc+is%3Aissue).
- type: checkboxes
attributes:
label: Latest version
description: Have you tested the latest version of the package(s) you’re reporting the bug for?
options:
- label: I have tested the latest version
required: true
- type: textarea
attributes:
label: Description
description: Tell us what's going wrong. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Describe the steps or code needed to reproduce this bug. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: What did you expect to happen?
- type: markdown
attributes:
value: "## Your Environment"
- type: dropdown
attributes:
label: Package name(s)
description: |
Which package(s) did you observe this bug in?
Which package(s) did you observe this bug in? If you’re not sure which version your project is using, run `npm ls [package name]` or `yarn why [package name]` to find out.
We only accept bug reports for packages shown in the menu below. If a package isn’t listed, then it’s not one that we support.
multiple: true
Expand All @@ -24,30 +53,24 @@ body:
- "Lab (@salt-ds/lab)"
- "Data Grid (@salt-ds/data-grid)"
- "AG Grid Theme (@salt-ds/ag-grid-theme)"
- "Website / Documentation"
validations:
required: true
- type: textarea
attributes:
label: Package version(s)
description: |
Which version(s) did you observe the bug in?
Which version(s) did you observe the bug in?
Please provide the exact version(s) instead of a [range](https://github.com/npm/node-semver#advanced-range-syntax) (`^`, `~`, `>`, `*`, `X`). If you’re not sure which version your project is using, run `npm ls [package name]` or `yarn why [package name]` to find out.
- type: textarea
attributes:
label: Description
description: Tell us what's going wrong. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Describe the steps or code needed to reproduce this bug. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
- type: textarea
- type: checkboxes
attributes:
label: Expected behavior
description: What did you expect to happen?
label: Browser
description: In which browser(s), if any, have you observed the bug?
options:
- label: Chrome
- label: Safari
- label: Firefox
- label: Microsoft Edge
- type: checkboxes
attributes:
label: Operating system
Expand All @@ -58,15 +81,9 @@ body:
- label: Linux
- label: iOS
- label: Android
- type: checkboxes
- type: markdown
attributes:
label: Browser
description: In which browser(s), if any, have you observed the bug?
options:
- label: Chrome
- label: Safari
- label: Firefox
- label: Edge
value: "## Other"
- type: checkboxes
attributes:
label: Are you a JPMorgan Chase & Co. employee?
Expand Down
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Documentation 📚
description: Have an issue or suggestion for the documentation?
labels:
- "type: documentation"
- "status: awaiting triage"
body:
- type: markdown
attributes:
value: |
### ⚠️ Warning
This is a public repository, so **please do not include any internal company code or sensitive data** in your bug report. If you are an internal JPM user, please also look at your [internal options](go/salt-ds-support).
- type: markdown
attributes:
value: Thanks for taking the time to report a bug! Before you start, please check that your issue isn’t already reported by searching the [existing issues](https://github.com/jpmorganchase/salt-ds/issues?q=sort%3Aupdated-desc+is%3Aissue).
- type: input
attributes:
label: Related page(s)
description: Which page or section of the Salt Design System documentation is this about?
placeholder: https://saltdesignsystem.com/
validations:
required: true
- type: dropdown
attributes:
label: Kind of issue
description: What kind of issue are you experiencing?
options:
- Unclear explanation
- Missing information
- Broken example
- Other
validations:
required: true
- type: textarea
attributes:
label: Description
description: Tell us what's going wrong. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
validations:
required: true
- type: markdown
attributes:
value: "## Your Environment"
- type: checkboxes
attributes:
label: Browser
description: In which browser(s), if any, have you observed the bug?
options:
- label: Chrome
- label: Safari
- label: Firefox
- label: Microsoft Edge
- type: checkboxes
attributes:
label: Operating system
description: On which operating system(s) have you observed the bug?
options:
- label: macOS
- label: Windows
- label: Linux
- label: iOS
- label: Android
- type: markdown
attributes:
value: "## Other"
- type: checkboxes
attributes:
label: Are you a JPMorgan Chase & Co. employee?
description: We ask this in case we need to contact you directly via internal company systems. Leave the box unticked if this doesn’t apply to you.
options:
- label: I am an employee of JPMorgan Chase & Co.
38 changes: 17 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feature request 💡
description: Suggest new functionality, components or ideas for the Salt Design System.
description: Want to suggest new functionality, components or ideas?
labels:
- "type: enhancement 💡"
- "status: awaiting triage"
Expand All @@ -8,41 +8,37 @@ body:
attributes:
value: |
### ⚠️ Warning
This is a public repository, so **please do not include any internal company code or sensitive data** in your bug report.
- type: dropdown
This is a public repository, so **please do not include any internal company code or sensitive data** in your bug report. If you are an internal JPM user, please also look at your [internal options](go/salt-ds-support).
- type: markdown
attributes:
label: Area
description: |
Which aspect(s) of the Salt Design System does your proposed feature relate to? Select all that apply.
multiple: true
options:
- UI Components
- Documentation
- Process
- Tools
- Website
validations:
required: true
value: Thanks for taking the time to report a bug! Before you start, please check that your feature isn’t already requested by searching the [existing issues](https://github.com/jpmorganchase/salt-ds/issues?q=sort%3Aupdated-desc+is%3Aissue).
- type: textarea
attributes:
label: The problem
description: |
Provide a clear and concise description of what the problem is. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
label: Description
description: Provide a clear and concise description of the feature.
validations:
required: true
- type: textarea
attributes:
label: The solution
label: Expected behavior
description: Tell us what functionality or behavior, for example, you would prefer instead. Feel free to attach design mock ups or specifications you may have.
validations:
required: true
- type: textarea
attributes:
label: Alternatives and examples
description: |
Describe or share alternative solutions or features you've considered that you may have seen elsewhere. Make sure that you copy and paste _as text_ any code, errors or log messages. Where relevant, you can also include supporting screenshots.
description: Describe or share alternative solutions or features you've considered that you may have seen elsewhere.
validations:
required: true
- type: textarea
attributes:
label: Context
description: Providing context helps us understand the problem you're trying to solve. For example, what are you trying to accomplish? How does this feature fit into your workflow?
validations:
required: true
- type: markdown
attributes:
value: "## Other"
- type: checkboxes
attributes:
label: Are you a JPMorgan Chase & Co. employee?
Expand Down
88 changes: 0 additions & 88 deletions .github/ISSUE_TEMPLATE/research-request.yml

This file was deleted.

0 comments on commit 4987cca

Please sign in to comment.