From dd81a4073fbf2e0e120e0819ef0f8e931c962fd4 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 1 Oct 2025 11:08:40 -1000 Subject: [PATCH] ;github:issue template: improve --- .github/ISSUE_TEMPLATE/a-bug.md | 35 ++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/a-bug.md b/.github/ISSUE_TEMPLATE/a-bug.md index be900c2c7..c871ee3b8 100644 --- a/.github/ISSUE_TEMPLATE/a-bug.md +++ b/.github/ISSUE_TEMPLATE/a-bug.md @@ -6,16 +6,29 @@ title: '' assignees: '' --- -Thanks for reporting. -Remember to check the manual first (the correct version): -https://hledger.org/hledger.html -https://hledger.org/hledger-ui.html -https://hledger.org/hledger-web.html +Thanks for helping to make hledger better. +Before reporting a bug, you may want to check: -If possible, please mention/include: -your `hledger --version` output, -the OS you're running on, -a link to any relevant doc that you found, -and a small reproducible example or recipe. +1. The appropriate manual (choosing the correct version at the top of the page): +- https://hledger.org/hledger.html +- https://hledger.org/hledger-ui.html +- https://hledger.org/hledger-web.html -(Please remove all of this text before submitting.) +2. The FAQ: https://hledger.org/faq.html + +3. The release notes: https://hledger.org/relnotes.html + +4. The issue tracker: https://bugs.hledger.org +Some notable issues are pinned at the top here. + +5. The #hledger matrix chat room: https://hledger.org/support.html +Notable issues are pinned here also. + +When reporting, please include these when appropriate: + +- the output of `hledger --version`, or even better, of `hledger setup` +- the OS you're running on +- a link to a relevant doc you found, if any +- a small reproducible example or recipe. + +Please remove all of this text before submitting.