;github: new issue templates: cleanups

This commit is contained in:
Simon Michael 2023-12-12 22:31:05 -10:00
parent d2f95966ab
commit 1c840e144c
2 changed files with 23 additions and 24 deletions

View File

@ -1,25 +1,23 @@
---
name: A bug
about: A problem or weakness in the software, documentation, usability, or project
about: A weakness in the software, documentation, usability, or project
labels: A BUG
---
Thank you for helping to make hledger better!
You can delete this template text before submitting.
You can delete the following text before submitting.
Some things to check before reporting:
Thanks for your report! Some tips:
- Have you checked the hledger manuals, and the right version ?
Eg for `hledger`: run `hledger help`, or go to
https://hledger.org/hledger.html and select your version at the top.
- If you're not sure this is a bug, or if some discussion would help,
contact us on chat or the mail list first: https://hledger.org/support.html
contact us on chat or the mail list first:
https://hledger.org/support.html
- Have you looked at (the right version of) the user manual ?
Use `hledger help [--help]` to view the built-in manuals,
or view the hledger.org -> USER MANUALS and choose the right version
at the top of the page.
Things that can help us resolve your issue faster:
- A small reproducible example (--anon can help anonymise data)
- The output of hledger --version
- What platform you're on
- Any related docs that you found
- Consider adding:
- A small reproducible example
- The output of hledger --version
- What platform you're on
- Links to any related docs that you found

View File

@ -1,6 +1,6 @@
---
name: A wish
about: An enhancement request or proposal for improving hledger or the hledger project.
about: A request or proposal for improving hledger or the project.
labels: A WISH
---
@ -8,13 +8,14 @@ You can delete the following text before submitting.
Thanks for your suggestion! Some tips:
- We try to not clutter the bug tracker with a ton of wishes.
Sometimes it's best to discuss and attract interest on chat or the mail list first.
- Have you looked for related features in the hledger manuals ? Eg:
https://hledger.org/dev/hledger.html
- We try to not clutter the bug tracker with too many wishes, since ideas are endless and developers are few.
Often it's better to discuss and build interest on chat or the mail list first:
https://hledger.org/support.html
- Have you looked for related features in the hledger manuals ?
https://hledger.org/dev/hledger.html is the latest hledger manual.
- Consider adding:
- A draft of command line help and user manual content and location
- A small example or mockup of your intended output or UI.
- A draft of command line help
- A draft of user manual content and suggested location
- A small mockup or example of intended output or UI.