branch: elpa/flycheck
commit fea21359413f59b15f36ef2e237399341237259f
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Convert issue templates to YAML issue forms
Migrate from the legacy Markdown format to the structured YAML issue
forms for better validation and UX. Key improvements include required
fields, a dropdown for Emacs configuration, a dedicated Emacs version
field, a use case field for feature requests, and auto-formatted
verify-setup output.
---
.github/ISSUE_TEMPLATE/bug_report.md | 55 -------------------
.github/ISSUE_TEMPLATE/bug_report.yml | 83 +++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 26 ---------
.github/ISSUE_TEMPLATE/feature_request.yml | 38 ++++++++++++++
.github/ISSUE_TEMPLATE/user-support.md | 58 ---------------------
.github/ISSUE_TEMPLATE/user-support.yml | 84 ++++++++++++++++++++++++++++++
6 files changed, 205 insertions(+), 139 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 2e8dad39c7..0000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,55 +0,0 @@
----
-name: Bug report
-about: Report an unexpected Flycheck behavior
-title: ''
-labels: 'kind: bug'
-assignees: ''
-
----
-
-Thank you for taking the time to report an issue and improve Flycheck. This
template is for **actual bugs you observed**. If you have trouble setting up
Flycheck, or if you have a question, please use the relevant issue template
instead.
-
-## Checklist
-
-- [ ] I have checked existing issues for potential duplicates before creating
this one.
-- [ ] I have read the [Troubleshooting guide][].
-
-## Bug description
-
-A clear and concise description of what the bug is.
-
-## Steps to reproduce
-
-Steps to reproduce the behavior:
-1. Open file '...'
-2. Do '....'
-3. See error
-
-- [ ] I have read
https://emacs.stackexchange.com/questions/28429/how-do-i-troubleshoot-emacs-problems
-
-## Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-## Screenshots
-
-If applicable, add screenshots to help explain your problem.
-
-## System configuration
-
-```
-Paste the output of `M-x flycheck-verify-setup` here.
-```
-
-Emacs configuration:
-- [ ] Plain Emacs / Custom configuration
-- [ ] Spacemacs
-- [ ] Doom Emacs
-- [ ] Prelude
-- [ ] Other shared configuration (please specify)
-
-## Additional notes
-
-Add any other context about the problem here.
-
-[Troubleshooting guide]:
https://www.flycheck.org/en/latest/user/troubleshooting.html
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml
b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..4110a82d93
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,83 @@
+name: Bug report
+description: Report an unexpected Flycheck behavior
+labels: ["kind: bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for taking the time to report a bug. Please fill out the
form below.
+
+ **Before submitting**, make sure you have:
+ - Searched [existing
issues](https://github.com/flycheck/flycheck/issues) for duplicates
+ - Read the [Troubleshooting
guide](https://www.flycheck.org/en/latest/user/troubleshooting.html)
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Bug description
+ description: A clear and concise description of the bug.
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to reproduce
+ description: Minimal steps to reproduce the behavior.
+ placeholder: |
+ 1. Open file '...'
+ 2. Do '...'
+ 3. See error
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected behavior
+ description: What did you expect to happen instead?
+ validations:
+ required: true
+
+ - type: textarea
+ id: verify-setup
+ attributes:
+ label: Output of M-x flycheck-verify-setup
+ description: Run `M-x flycheck-verify-setup` in the affected buffer and
paste the output here.
+ render: text
+ validations:
+ required: true
+
+ - type: input
+ id: emacs-version
+ attributes:
+ label: Emacs version
+ description: Output of `M-x emacs-version`.
+ placeholder: "e.g. GNU Emacs 30.1"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: emacs-config
+ attributes:
+ label: Emacs configuration
+ options:
+ - Plain Emacs / Custom configuration
+ - Spacemacs
+ - Doom Emacs
+ - Prelude
+ - Other (please specify in additional notes)
+ validations:
+ required: true
+
+ - type: textarea
+ id: screenshots
+ attributes:
+ label: Screenshots
+ description: If applicable, add screenshots to help explain the problem.
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional notes
+ description: Any other context about the problem.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md
b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 176526297c..0000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-name: Feature request
-about: Suggest an improvement to Flycheck
-title: ''
-labels: 'kind: feature request'
-assignees: ''
-
----
-
-Thank you for taking the time to improve Flycheck.
-
-## Checklist
-
-- [ ] I have checked existing issues for potential duplicates before creating
this one.
-
-## Feature description
-
-A clear and concise description of what you want Flycheck to do.
-
-## 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, mockups etc.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml
b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000000..5999f1ff56
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,38 @@
+name: Feature request
+description: Suggest an improvement to Flycheck
+labels: ["kind: feature request"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you for taking the time to suggest an improvement.
+
+ **Before submitting**, please search [existing
issues](https://github.com/flycheck/flycheck/issues) to check if this has
already been requested.
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Feature description
+ description: A clear and concise description of what you want Flycheck
to do.
+ validations:
+ required: true
+
+ - type: textarea
+ id: use-case
+ attributes:
+ label: Use case
+ description: What problem does this solve? How would you use this
feature in your workflow?
+ validations:
+ required: true
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives considered
+ description: Any alternative solutions or workarounds you've considered.
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional context
+ description: Any other context, screenshots, or mockups.
diff --git a/.github/ISSUE_TEMPLATE/user-support.md
b/.github/ISSUE_TEMPLATE/user-support.md
deleted file mode 100644
index 04e695395b..0000000000
--- a/.github/ISSUE_TEMPLATE/user-support.md
+++ /dev/null
@@ -1,58 +0,0 @@
----
-name: User support
-about: Trouble setting up or using Flycheck?
-title: ''
-labels: 'kind: user support'
-assignees: ''
-
----
-
-This template is for **user support**. If you are reporting an actual
Flycheck bug, please use the relevant issue template instead.
-
-## Checklist
-
-- [ ] I have searched existing issues and StackOverflow for solutions.
-- [ ] I have read the [Flycheck manual][].
-- [ ] I have read the [Troubleshooting Guide][].
-- [ ] I have checked my issue has not been reported yet.
-
-## Problem description
-
-A clear and concise description of the problem you encounter.
-
-## Steps to reproduce
-
-Steps to reproduce the behavior:
-1. Open file '...'
-2. Do '....'
-3. See error
-
-- [ ] I have read
https://emacs.stackexchange.com/questions/28429/how-do-i-troubleshoot-emacs-problems
-
-## Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-## Screenshots
-
-If applicable, add screenshots to help explain your problem.
-
-## System configuration
-
-```
-Paste the output of `M-x flycheck-verify-setup` here.
-```
-
-Emacs configuration:
-- [ ] Plain Emacs / Custom configuration
-- [ ] Spacemacs
-- [ ] Doom Emacs
-- [ ] Prelude
-- [ ] Other shared configuration (please specify)
-
-## Additional notes
-
-Add any other context about the problem here.
-
-[Flycheck manual]: https://www.flycheck.org/en/latest/
-[Troubleshooting guide]:
https://www.flycheck.org/en/latest/user/troubleshooting.html
diff --git a/.github/ISSUE_TEMPLATE/user-support.yml
b/.github/ISSUE_TEMPLATE/user-support.yml
new file mode 100644
index 0000000000..7ad0eaa90b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/user-support.yml
@@ -0,0 +1,84 @@
+name: User support
+description: Trouble setting up or using Flycheck?
+labels: ["kind: user support"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ This template is for **setup and usage questions**. If you are
reporting an actual bug, please use the bug report template instead.
+
+ **Before submitting**, make sure you have:
+ - Searched [existing
issues](https://github.com/flycheck/flycheck/issues) and
[StackOverflow](https://stackoverflow.com/questions/tagged/flycheck) for
solutions
+ - Read the [Flycheck manual](https://www.flycheck.org/en/latest/)
+ - Read the [Troubleshooting
guide](https://www.flycheck.org/en/latest/user/troubleshooting.html)
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Problem description
+ description: A clear and concise description of the problem you're
encountering.
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to reproduce
+ description: Steps to reproduce the behavior.
+ placeholder: |
+ 1. Open file '...'
+ 2. Do '...'
+ 3. See error
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected behavior
+ description: What did you expect to happen instead?
+ validations:
+ required: true
+
+ - type: textarea
+ id: verify-setup
+ attributes:
+ label: Output of M-x flycheck-verify-setup
+ description: Run `M-x flycheck-verify-setup` in the affected buffer and
paste the output here.
+ render: text
+ validations:
+ required: true
+
+ - type: input
+ id: emacs-version
+ attributes:
+ label: Emacs version
+ description: Output of `M-x emacs-version`.
+ placeholder: "e.g. GNU Emacs 30.1"
+ validations:
+ required: true
+
+ - type: dropdown
+ id: emacs-config
+ attributes:
+ label: Emacs configuration
+ options:
+ - Plain Emacs / Custom configuration
+ - Spacemacs
+ - Doom Emacs
+ - Prelude
+ - Other (please specify in additional notes)
+ validations:
+ required: true
+
+ - type: textarea
+ id: screenshots
+ attributes:
+ label: Screenshots
+ description: If applicable, add screenshots to help explain the problem.
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional notes
+ description: Any other context about the problem.
