diff --git a/.github/ISSUE_TEMPLATE/a-bug.md b/.github/ISSUE_TEMPLATE/a-bug.md index eff7462e5..f596f0915 100644 --- a/.github/ISSUE_TEMPLATE/a-bug.md +++ b/.github/ISSUE_TEMPLATE/a-bug.md @@ -6,25 +6,25 @@ title: '' assignees: '' --- -Thanks for helping to make hledger better! -Here are some good things to check when reporting a bug: +Thanks for helping to make hledger better! Here's how to make a good bug report: -- Your hledger version (run `hledger --version`). It's best if it's not very old. - 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-ui.html +1. Check: + +- `hledger --version` it's best if it's not very old +- https://hledger.org/install.html shows the current version and how to upgrade +- https://hledger.org/hledger.html the manual (choose your version at top of page) + https://hledger.org/hledger-ui.html https://hledger.org/hledger-web.html -- https://hledger.org/relnotes.html to see recent fixes and changes. -- https://bugs.hledger.org to see bugs already reported. -- https://hledger.org/faq.html for some answers to common questions. -- https://hledger.org/support.html -> chat if you have questions. +- https://hledger.org/relnotes.html recent fixes and upgrade notes +- https://bugs.hledger.org bugs already reported +- https://hledger.org/faq.html answers to common questions +- https://hledger.org/support.html if you have other questions -In your bug report, please include if possible: +2. In your bug report, please include if possible: - 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.) \ No newline at end of file +3. And remove this help text.