diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index af45e3d0..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -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. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..d47f1ed9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/document-error.md b/.github/ISSUE_TEMPLATE/document-error.md deleted file mode 100644 index 4b75677e..00000000 --- a/.github/ISSUE_TEMPLATE/document-error.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Document error -about: Report document errors or suggestions -title: '' -labels: documents -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. diff --git a/.github/ISSUE_TEMPLATE/document-error.yml b/.github/ISSUE_TEMPLATE/document-error.yml new file mode 100644 index 00000000..3dc2ab09 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/document-error.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -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. - -**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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..d0c291aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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