Skip to content

Commit

Permalink
[Docs] Update issue templates (#563)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
stichbury and pre-commit-ci[bot] authored Jul 9, 2024
1 parent 060ca69 commit a497059
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 79 deletions.
48 changes: 15 additions & 33 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,10 @@ body:
- type: markdown
attributes:
value: >-
Hi there! Thank you so much for taking the time to fill in this bug form. It will be
a valuable contribution to Vizro.
Hi there! Thank you so much for taking the time to fill in this bug report.
As we have limited triage capacity, we'd appreciate it if you could search on Vizro's
existing issues prior to submission to avoid any duplicates. Thanks!
We'd appreciate it if you could search on Vizro's existing issues prior to filing
a bug report to avoid any duplicate tickets, as we have limited maintainer capacity to triage
them. Thanks!
- type: textarea
attributes:
label: Description
description: >-
A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: >-
A clear and concise description of what you expected to happen.
- type: dropdown
attributes:
label: Which package?
Expand All @@ -34,26 +18,25 @@ body:
- vizro-ai
validations:
required: true

- type: input
attributes:
label: Package version
validations:
required: true
- type: input
attributes:
label: Python version
validations:
required: true
- type: input

- type: textarea
attributes:
label: OS
label: Description
description: >-
A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: How to Reproduce
description: Please provide steps to reproduce this bug.
description: Provide steps to reproduce this bug. You can also [use a py.cafe link](https://py.cafe/snippet/vizro/v1) to share your example.
placeholder: |
1. Get package from '...'
2. Then run '...'
Expand All @@ -65,14 +48,13 @@ body:
attributes:
label: Output
description: >-
Provide the output of the steps above, including the commands
If you can, provide the output of the steps above, including the commands
themselves and Vizro's output/traceback etc. If possible,
please also provide a screenshot highlighting the issue.
provide a screenshot highlighting the issue or [link to a py.cafe example](https://py.cafe/snippet/vizro/v1).
If you want to present output from multiple commands, please prefix
the line containing the command with `$ `. Please also ensure that
the "How to reproduce" section contains matching instructions for
reproducing this.
If you want to present output from multiple commands, prefix
the line containing the command with `$ `. Ensure that
the "How to reproduce" section contains matching instructions.
- type: checkboxes
attributes:
Expand Down
28 changes: 4 additions & 24 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ body:
- type: markdown
attributes:
value: >-
Hi there! Thank you so much for taking the time to fill in this feature request form.
It will be a valuable contribution to Vizro.
We'd appreciate it if you could search on Vizro's existing issues prior to filing
a feature request to avoid any duplicate tickets, as we have limited maintainer capacity to triage
them. Thanks!
Hi there! Thank you so much for taking the time to fill in this feature request.
As we have limited triage capacity, we'd appreciate it if you could search on Vizro's
existing issues prior to submission to avoid any duplicates. Thanks!
- type: dropdown
attributes:
label: Which package?
Expand All @@ -23,7 +20,7 @@ body:
label: What's the problem this feature will solve?
description: >-
What are you trying to do, that you are unable to achieve with Vizro as it
currently stands?
currently stands? Have you tried to work around the problem using Vizro or other tools?
validations:
required: true

Expand All @@ -37,23 +34,6 @@ body:
validations:
required: true

- type: textarea
attributes:
label: Alternative Solutions
description: >-
Have you tried to workaround the problem using Vizro or other tools? Or a
different approach to solving this issue? Please elaborate here.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: >-
Add any other context, links, etc. relevant to the feature request.
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
Expand Down
27 changes: 5 additions & 22 deletions .github/ISSUE_TEMPLATE/general-question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ body:
- type: markdown
attributes:
value: >-
Hi there! Thank you so much for taking the time to fill in this question form. It will be
a valuable contribution to Vizro.
We'd appreciate it if you could search on Vizro's existing issues prior to filing
a general question to avoid any duplicate tickets, as we have limited maintainer capacity to triage
them. Thanks!
Hi there! Thank you so much for taking the time to fill in this general question.
As we have limited triage capacity, we'd appreciate it if you could search on Vizro's
existing issues prior to submission to avoid any duplicates. Thanks!
- type: textarea
attributes:
Expand All @@ -25,29 +22,15 @@ body:
attributes:
label: Code/Examples
description: >-
Please post any supporting code around your question here.
- type: textarea
attributes:
label: Other information
description: >-
Please provide any attempts on answering the question, or any related information you already found here.
Post any supporting code around your question here or as a [py.cafe link](https://py.cafe/snippet/vizro/v1).
Don't forget to include the package version, if it's relevant.
- type: dropdown
attributes:
label: Which package?
options:
- vizro
- vizro-ai
- type: input
attributes:
label: Package version
- type: input
attributes:
label: Python version
- type: input
attributes:
label: OS

- type: checkboxes
attributes:
Expand Down

0 comments on commit a497059

Please sign in to comment.