Skip to content

Commit

Permalink
chore: use form for bug report template
Browse files Browse the repository at this point in the history
- 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>
  • Loading branch information
miurahr committed May 6, 2024
1 parent 89ed69b commit 0eb8ae8
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 36 deletions.
91 changes: 57 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,57 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. install `aqt` using this command
2. run `aqt` with this command
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**`aqt` output**
Add program output to help explain your problem.

```
paste program output here
```

**Desktop (please complete the following information):**
- OS: [e.g. windows]
- `aqt` version [paste the output from the command `aqt version` or `python -m aqt version`]

**Additional context**
Add any other context about the problem here.
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
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/document-error.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@ assignees: ''
---

**Describe the document error or request**
<!--
A clear and concise description of what the error is.
-->

**Proposed change**
<!--
A clear and concise description of what you want to see.
-->

**Additional context**
<!--
Add any other context about the problem here.
-->
8 changes: 6 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ assignees: ''
---

**Is your feature request related to a problem? Please describe.**
<!--
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-->

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
<!--
A clear and concise description of any alternative solutions or features you've considered.
-->

**Additional context**
Add any other context or screenshots about the feature request here.
<!-- Add any other context or screenshots about the feature request here. -->

0 comments on commit 0eb8ae8

Please sign in to comment.