Skip to content

Commit

Permalink
chore: update bug report/document error report/feature request form t…
Browse files Browse the repository at this point in the history
…emplate (#789)

* chore: use form for bug report template

- Request mandatory information in forms.
- Add checkbox to select OS
- Add checkbox to request CoC
- other templates: comment out descriptions

Signed-off-by: Hiroshi Miura <miurahr@linux.com>

* chore: use form for document and feature request template

- Request mandatory information in forms.
- Add checkbox to request CoC

Signed-off-by: Hiroshi Miura <miurahr@linux.com>

---------

Signed-off-by: Hiroshi Miura <miurahr@linux.com>
  • Loading branch information
miurahr authored May 7, 2024
1 parent 27c351f commit 2cd1383
Show file tree
Hide file tree
Showing 6 changed files with 135 additions and 71 deletions.
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: Bug description
description: Explain the buggy behavior, and how to reproduce it.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: What did you expect?
validations:
required: true
- type: input
id: version
attributes:
label: aqt and python version
description: Please paste the output from the command `aqt version` or `python -m aqt version`]
placeholder: a version, like v3.1.12 on Python 3.9.19 (CPython GCC 11.4.0)
validations:
required: true
- type: dropdown
id: operatingSystem
attributes:
label: Operating System
description: On what Operating System(s) do you observe the problem?
multiple: true
options:
- "Linux/Unix"
- MacOS
- Windows
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://aqtinstall.readthedocs.io/en/latest/CODE_OF_CONDUCT.html).
options:
- label: I agree to follow this project's Code of Conduct
required: true
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/document-error.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/document-error.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Document error
description: File a document error report.
title: "[Docs]: "
labels: ["documents", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this document error report or suggestion!
- type: textarea
id: description
attributes:
label: document error or request
description: A clear and concise description of what the error is.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed change
description: A clear and concise description of what you want to see.
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://aqtinstall.readthedocs.io/en/latest/CODE_OF_CONDUCT.html).
options:
- label: I agree to follow this project's Code of Conduct
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a suggestion!
- type: textarea
id: description
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: proposal
attributes:
label: The solution
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternative
attributes:
label: Alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://aqtinstall.readthedocs.io/en/latest/CODE_OF_CONDUCT.html).
options:
- label: I agree to follow this project's Code of Conduct
required: true

0 comments on commit 2cd1383

Please sign in to comment.