;doc:issue template: improve

This commit is contained in:
Simon Michael 2026-01-09 09:29:31 -10:00
parent 932de54aa9
commit 9307c178c9

View File

@ -6,24 +6,30 @@ title: ''
assignees: '' assignees: ''
--- ---
Thanks for helping to make hledger better. Thanks for helping to make hledger better!
For a high quality bug report, here are some good things to check first:
Before reporting a bug, these are some good places to check: - Your hledger version (run `hledger --version`). It's best if it's not very old.
The appropriate manual (choosing the correct version at the top of the page): https://hledger.org/install.html shows the current version and how to upgrade.
- The appropriate manual, choosing the right version at the top of the page:
https://hledger.org/hledger.html https://hledger.org/hledger.html
https://hledger.org/hledger-ui.html https://hledger.org/hledger-ui.html
https://hledger.org/hledger-web.html https://hledger.org/hledger-web.html
FAQ: https://hledger.org/faq.html
Release notes: https://hledger.org/relnotes.html - https://hledger.org/relnotes.html lists recent fixes and changes.
Issue tracker: https://bugs.hledger.org (some notable issues are pinned)
Matrix chat: https://hledger.org/support.html (issues are pinned here too) - https://bugs.hledger.org shows the bugs already reported.
- https://hledger.org/faq.html answers some common questions.
- https://hledger.org/support.html -> chat if you have questions.
In your bug report, please include if possible: In your bug report, please include if possible:
- output of `hledger --version` (or best of all, `hledger setup`).
Note, it's best if your hledger version is not too old.
https://hledger.org/install.html shows the current version and how to upgrade.
- which OS you're running on
- a link to a relevant doc you found, if any
- a small reproducible example or recipe.
(And remember to remove all of this boilerplate text before submitting.) - the output of `hledger --version` or (best) `hledger setup`
- which operating system you're running on
- a link to the most relevant doc that you found, if any
- a small reproducible example or instructions to reproduce.
(And remove this boilerplate text before submitting.)