summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2024-04-20 11:43:15 +0300
committerDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2024-04-20 11:44:22 +0300
commit386153f1a7e73fca2b63c6f593b30717316e04fa (patch)
treed77932de8e3b65ab20690a02719f9a3fc8628660 /.github
parent4f72e2656dad879a031378d4e2757125f275d95e (diff)
github: update bug filing template
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/mu4e-bug-report.md26
1 files changed, 19 insertions, 7 deletions
diff --git a/.github/ISSUE_TEMPLATE/mu4e-bug-report.md b/.github/ISSUE_TEMPLATE/mu4e-bug-report.md
index cb5c0b2..63d857f 100644
--- a/.github/ISSUE_TEMPLATE/mu4e-bug-report.md
+++ b/.github/ISSUE_TEMPLATE/mu4e-bug-report.md
@@ -7,23 +7,35 @@ assignees: ''
---
**Describe the bug**
+
+Give the bug a good title.
+
Please provide a clear and concise description of what you expected to happen
-and what actually happened.
+and what actually happened, and follow the steps below.
**How to Reproduce**
+
Include the exact steps of what you were doing (commands executed etc.). Include
-any relevant logs and outputs. Best start with `emacs -Q` and a minimal `mu4e` setup.
+any relevant logs and outputs:
-If this is about a specific (kind of) message, attach an example message. (Open
-the message, press `.` (`mu4e-view-raw-message`), then `C-x C-w` and attach.
-Anonymize as needed, all that matters is that the issue still reproduces.
+- Best start from `emacs -Q`, and load a minimal `mu4e` setup; describe the steps
+ that lead up to the bug.
+- Does the problem happen each time? Sometimes?
+- If this is about a specific (kind of) message, attach an example message.
+ (Open the message, press `.` (`mu4e-view-raw-message`), then `C-x C-w` and
+ attach. Anonymize as needed, all that matters is that the issue still
+ reproduces.
**Environment**
+
Please describe the versions of OS, Emacs, mu/mu4e etc. you are using.
**Checklist**
-- [ ] you are running either an 1.8.x/1.10.x release or `master` (otherwise please upgrade)
+
+- [ ] you are running either an 1.10.x/1.12.x release or `master` (otherwise please upgrade)
- [ ] you can reproduce the problem without 3rd party extensions (including Doom/Evil, various extensions etc.)
- [ ] you have read all of the above
-Please make sure you all items in the checklist are set/met before filing the ticket. Thank you! \ No newline at end of file
+Please make sure you all items in the checklist are set/met before filing the ticket.
+
+Thank you!