;tools
update issue templates
This commit is contained in:
parent
ef89b67d7a
commit
3bf0b85084
21
.github/ISSUE_TEMPLATE/a-bug.md
vendored
21
.github/ISSUE_TEMPLATE/a-bug.md
vendored
@ -1,12 +1,21 @@
|
||||
---
|
||||
name: A bug
|
||||
about: A weakness in the software, documentation, usability, or project
|
||||
about: A defect in the software, core documentation, user/developer experience, or project
|
||||
labels: A BUG
|
||||
title: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
Thanks for reporting! Here are some tips (please remove this text before submitting):
|
||||
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
|
||||
|
||||
- Have you checked (the right version of) the manual ? Eg https://hledger.org/hledger.html
|
||||
- If some discussion would help, just ask in chat or mail list: https://hledger.org/support.html
|
||||
- Any of these are very helpful: a small reproducible example, hledger --version output,
|
||||
what platform you're running on, a link to to any relevant doc that you found.
|
||||
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.
|
||||
|
||||
(Please remove all of this text before submitting.)
|
||||
|
||||
30
.github/ISSUE_TEMPLATE/a-wish.md
vendored
30
.github/ISSUE_TEMPLATE/a-wish.md
vendored
@ -1,21 +1,25 @@
|
||||
---
|
||||
name: A wish
|
||||
about: A request or proposal for improving hledger or the project.
|
||||
about: A proposal for improving hledger or the project
|
||||
labels: A WISH
|
||||
title: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
Thanks for your suggestion! Here are some tips (please delete them before submitting):
|
||||
Thanks for contributing. But first:
|
||||
|
||||
- Have you looked for related features in the hledger manuals ? Eg:
|
||||
https://hledger.org/dev/hledger.html
|
||||
- Have you looked for related features in the hledger manual (latest version) ?
|
||||
https://hledger.org/hledger.html
|
||||
https://hledger.org/hledger-ui.html
|
||||
https://hledger.org/hledger-web.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
|
||||
- Ideas are endless and developers are few, so we try to not clutter the bug tracker with wishes.
|
||||
Often it's best to discuss them on chat/mail list/forum first:
|
||||
https://hledger.org/support
|
||||
|
||||
- Not required, but any of these help to move things forward:
|
||||
- A draft of user manual content and suggested location.
|
||||
- A draft of command line help.
|
||||
- A small mockup or example of intended output or UI.
|
||||
- Appropriate topic labels, if you have the access level to set those.
|
||||
(If not, feel free to write them in the issue title, eg as a prefix.)
|
||||
- Concrete proposals with draft docs move forward more quickly. Consider adding:
|
||||
- A draft of user manual changes
|
||||
- A draft of command line help
|
||||
- A mockup of intended output or UI
|
||||
|
||||
(Please remove all of this text before submitting.)
|
||||
|
||||
10
.github/ISSUE_TEMPLATE/config.yml
vendored
10
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -3,10 +3,14 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
|
||||
- name: A hledger.org website issue
|
||||
url: https://github.com/simonmichael/hledger_site/issues
|
||||
about: Please use the hledger_site issue tracker
|
||||
|
||||
- name: A support request
|
||||
url: https://hledger.org/support.html
|
||||
about: For questions and support, please use our chat or mail list. See hledger.org > Support.
|
||||
url: https://hledger.org/support
|
||||
about: Please use chat, mail list or forum
|
||||
|
||||
- name: A security issue
|
||||
url: https://joyful.com
|
||||
about: Contact simon@joyful.com.
|
||||
about: Please contact Simon directly
|
||||
|
||||
Loading…
Reference in New Issue
Block a user