branch: elpa/clojure-mode
commit e7d8b57d4f37318040fe1eb71d5e1c8892d4db5c
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Convert issue templates to GitHub issue forms
Replace the old markdown bug report template with a structured YAML
form and add a feature request template. Add config.yml with a link
to search existing issues.
---
.github/ISSUE_TEMPLATE/bug_report.md | 39 ----------------
.github/ISSUE_TEMPLATE/bug_report.yml | 73 ++++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 5 ++
.github/ISSUE_TEMPLATE/feature_request.yml | 23 ++++++++++
4 files changed, 101 insertions(+), 39 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 9301f8f0ee..0000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,39 +0,0 @@
----
-name: Bug Report
-about: Report an issue with clojure-mode you've discovered.
-labels: [bug]
----
-
-*Use the template below when reporting bugs. Please, make sure that
-you're running the latest stable clojure-mode and that the problem you're
reporting
-hasn't been reported (and potentially fixed) already.*
-
-**Please, remove all of the placeholder text (the one in italics) in your
final report!**
-
-## Expected behavior
-
-## Actual behavior
-
-## Steps to reproduce the problem
-
-*This is extremely important! Providing us with a reliable way to reproduce
-a problem will expedite its solution.*
-
-## Environment & Version information
-
-### clojure-mode version
-
-*Include here the version string displayed by `M-x
-clojure-mode-display-version`. Here's an example:*
-
-```
-clojure-mode (version 5.20.0)
-```
-
-### Emacs version
-
-*E.g. 29.1* (use <kbd>C-h C-a</kbd> to see it)
-
-### Operating system
-
-*E.g. Windows 10*
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml
b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..9eb3f8623e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,73 @@
+name: Bug Report
+description: Report an issue with clojure-mode you've discovered.
+labels: [bug]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please make sure you're running the latest stable clojure-mode and
that the problem hasn't been reported already.
+ - type: dropdown
+ id: mode
+ attributes:
+ label: Affected mode
+ options:
+ - clojure-mode
+ - clojurescript-mode
+ - clojurec-mode
+ - clojuredart-mode
+ - edn-mode
+ - jank-mode
+ - joker-mode
+ validations:
+ required: true
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected behavior
+ description: What did you expect to happen?
+ validations:
+ required: true
+ - type: textarea
+ id: actual
+ attributes:
+ label: Actual behavior
+ description: What happened instead?
+ validations:
+ required: true
+ - type: textarea
+ id: steps
+ attributes:
+ label: Steps to reproduce
+ description: Providing a reliable way to reproduce the problem will
expedite its solution.
+ validations:
+ required: true
+ - type: checkboxes
+ id: emacs-q
+ attributes:
+ label: Reproducible with emacs -Q
+ description: Start Emacs with `emacs -Q`, install clojure-mode, and try
to reproduce. This rules out interference from your personal config.
+ options:
+ - label: I've reproduced this with `emacs -Q`
+ - type: input
+ id: clojure-mode-version
+ attributes:
+ label: clojure-mode version
+ description: Run `M-x clojure-mode-display-version` to find this.
+ placeholder: "e.g. 5.22.0"
+ validations:
+ required: true
+ - type: input
+ id: emacs-version
+ attributes:
+ label: Emacs version
+ description: Use `C-h C-a` to find this.
+ placeholder: "e.g. 30.1"
+ validations:
+ required: true
+ - type: input
+ id: os
+ attributes:
+ label: Operating system
+ placeholder: "e.g. macOS 15, Ubuntu 24.04, Windows 11"
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml
b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..a51a9cae72
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Search existing issues
+ url: https://github.com/clojure-emacs/clojure-mode/issues?q=is%3Aissue
+ about: Please check if your issue has already been reported before opening
a new one.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml
b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000000..92a6b70ed3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,23 @@
+name: Feature Request
+description: Suggest a new feature or enhancement for clojure-mode.
+labels: [enhancement]
+body:
+ - type: textarea
+ id: problem
+ attributes:
+ label: Problem
+ description: What problem are you trying to solve? What's missing or
frustrating?
+ validations:
+ required: true
+ - type: textarea
+ id: solution
+ attributes:
+ label: Proposed solution
+ description: How would you like this to work? Include examples if
possible.
+ validations:
+ required: true
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives considered
+ description: Any workarounds or alternative approaches you've tried or
considered?
