summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
author2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-07-04 21:16:03 +1000
committer2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>2025-07-04 21:16:03 +1000
commitad22b1e7e6067bc9a0304048e7bf2f712769f4f5 (patch)
treea10a6276466624ba06af8dbc7cfa93630134181c /.github/ISSUE_TEMPLATE
parentMerge branch 'main' of https://github.com/caelestia-dots/shell (diff)
downloadcaelestia-shell-ad22b1e7e6067bc9a0304048e7bf2f712769f4f5.tar.gz
caelestia-shell-ad22b1e7e6067bc9a0304048e7bf2f712769f4f5.tar.bz2
caelestia-shell-ad22b1e7e6067bc9a0304048e7bf2f712769f4f5.zip
issues: better templates
Use yaml for templates + force using a template
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md32
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml1
-rw-r--r--.github/ISSUE_TEMPLATE/feature.yml24
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md20
-rw-r--r--.github/ISSUE_TEMPLATE/issue.yml56
5 files changed, 81 insertions, 52 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 0b60657..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG] "
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Versions (please complete the following information):**
- - shell: [paste the output of `pacman -Q caelestia-shell-git` here]
- - cli [paste the output of `pacman -Q caelestia-cli-git` here]
- - quickshell [paste the output of `pacman -Q quickshell-git` here]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..3ba13e0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
new file mode 100644
index 0000000..c5caffa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature.yml
@@ -0,0 +1,24 @@
+name: Feature request
+description: Suggest a new feature
+labels: ["enhancement"]
+type: "Feature"
+title: "[FEATURE] "
+body:
+ - type: markdown
+ attributes:
+ value: "NOTE: Please write in **English**."
+
+ - type: textarea
+ attributes:
+ label: "What would you like to be added?"
+ description: "Can be a suggestion for an existing feature. You can suggest a widget, minor user interaction changes.. whatever."
+
+ - type: textarea
+ attributes:
+ label: "How will it help?"
+ description: "It's helpful to include examples (like in your use case)."
+
+ - type: textarea
+ attributes:
+ label: "Extra info"
+ description: "If you want a new widget, a pic of the inspiration (if available) would be awesome."
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 8403b86..0000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: "[FEATURE] "
-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/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml
new file mode 100644
index 0000000..e7867e1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue.yml
@@ -0,0 +1,56 @@
+name: Issue
+description: Report an issue with the dots
+labels: ["bug"]
+type: "Bug"
+title: "[BUG] "
+body:
+ - type: markdown
+ attributes:
+ value: "**Welcome to submit a new issue!**\n- It takes only 3 steps, so please be patient :)\n- Tip: If your issue is not a feature request and is not an issue with the dots (e.g. \"how do I use X feature\"), please use [Discussions](https://github.com/caelestia-dots/shell/discussions) instead."
+ - type: checkboxes
+ attributes:
+ label: "Step 1. Before you submit"
+ description: "Hint: The 2nd and 3rd checkbox is **not** forcely required as you may have failed to do so."
+ options:
+ - label: I have read the above instructions and am sure that this is supposed to be posted here.
+ required: true
+ - label: I've successfully updated to the latest versions following the [updating guide](https://github.com/caelestia-dots/caelestia?tab=readme-ov-file#updating).
+ required: false # Not required cuz user may have failed to do so
+ - label: I've successfully updated the system packages to the latest.
+ required: false # Not required cuz user may have failed to do so
+ - label: I've ticked the checkboxes without reading their contents
+ required: false # Obviously
+
+ - type: textarea
+ attributes:
+ label: "Step 2. Version info"
+ description: "Run `caelestia -v` and paste the result below."
+ value: "<details><summary>Version info</summary>\n\n```\n<!-- Run `caelestia -v` and paste the result here! -->\n```\n\n</details>"
+ validations:
+ required: true
+
+ - type: markdown
+ attributes:
+ value: |
+ **Tips for the following Step 3**
+ 1. Use `LANG=C LC_ALL=C` to get the output of a command in English, eg. `LANG=C LC_ALL=C date` displays time in English.
+ 2. If it throws errors, **PLEASE**, attach logs and describe in detail if possible.
+ - Something happened to the shell (bar, dashboard, etc)? Run `caelestia shell -l` WITHOUT exiting the shell for logs.
+ - Installation failed? Run installation again for logs.
+ - You may use more code blocks when needed.
+ 3. In case you are confused, the `<details>`, `<summary>`, `</summary>`, `</details>` are HTML tags for folding the logs (typically very long) inside. Please do not touch them (unless you know what you are doing).
+ 4. If the logs are suuuuuuper long, consider using an online pastebin service instead.
+
+ - type: textarea
+ attributes:
+ label: "Step 3. Describe the issue"
+ value: "\n<!-- Firsly describe your issue here! -->\n\n<details><summary>Logs</summary>\n\n```\n<!-- Put your log content here!-->\n```\n\n</details>"
+ validations:
+ required: true
+
+ - type: checkboxes
+ attributes:
+ label: Reminder
+ options:
+ - label: I agree that it's usually impossible for others to help me without my logs.
+ required: true