;doc:issue template: improve
This commit is contained in:
parent
8295e521a7
commit
f2ec9d58bc
26
.github/ISSUE_TEMPLATE/a-bug.md
vendored
26
.github/ISSUE_TEMPLATE/a-bug.md
vendored
@ -6,25 +6,25 @@ title: ''
|
|||||||
assignees: ''
|
assignees: ''
|
||||||
---
|
---
|
||||||
|
|
||||||
Thanks for helping to make hledger better!
|
Thanks for helping to make hledger better! Here's how to make a good bug report:
|
||||||
Here are some good things to check when reporting a bug:
|
|
||||||
|
|
||||||
- Your hledger version (run `hledger --version`). It's best if it's not very old.
|
1. Check:
|
||||||
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:
|
- `hledger --version` it's best if it's not very old
|
||||||
https://hledger.org/hledger.html
|
- https://hledger.org/install.html shows the current version and how to upgrade
|
||||||
https://hledger.org/hledger-ui.html
|
- 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/hledger-web.html
|
||||||
- https://hledger.org/relnotes.html to see recent fixes and changes.
|
- https://hledger.org/relnotes.html recent fixes and upgrade notes
|
||||||
- https://bugs.hledger.org to see bugs already reported.
|
- https://bugs.hledger.org bugs already reported
|
||||||
- https://hledger.org/faq.html for some answers to common questions.
|
- https://hledger.org/faq.html answers to common questions
|
||||||
- https://hledger.org/support.html -> chat if you have 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`
|
- the output of `hledger --version` or (best) `hledger setup`
|
||||||
- which operating system you're running on
|
- which operating system you're running on
|
||||||
- a link to the most relevant doc that you found, if any
|
- a link to the most relevant doc that you found, if any
|
||||||
- a small reproducible example or instructions to reproduce.
|
- a small reproducible example or instructions to reproduce.
|
||||||
|
|
||||||
(And remove this boilerplate text.)
|
3. And remove this help text.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user