tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: some small updates to README and issue templates

This commit is contained in:
ClementTsang 2022-06-05 18:29:14 -04:00
parent c1a7979be7
commit d0cb61a4c2
4 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -8,6 +8,8 @@ assignees: ""
Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems) to see if your problem is already reported/known/fixed. Before you report, please take a look at [Troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting) to see if there's already an answer to your problem. Also check out [existing issues](https://github.com/ClementTsang/bottom/issues) and [known problems](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems) to see if your problem is already reported/known/fixed.
If you just have a question, or want to troubleshoot something that you don't think is a bug, feel free to [open a discussion](https://github.com/ClementTsang/bottom/discussions/new).
Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed! Also, **please fill in all fields if possible** - if the issue is too hard to reproduce or vague, it may not be fixed!
## Describe the bug ## Describe the bug

4
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,6 +1,6 @@
blank_issues_enabled: true blank_issues_enabled: true
contact_links: contact_links:
- name: Ask a question - name: Open a discussion
about: | about: |
For discussions or questions about bottom. Got a question about using bottom? Need help troubleshooting something? Or maybe just talk about something related to bottom? Feel free to open a discussion!
url: https://github.com/ClementTsang/bottom/discussions/new url: https://github.com/ClementTsang/bottom/discussions/new

1
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -13,3 +13,4 @@ Try to be clear and concise - more details are usually helpful, but don't ramble
Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/nightly/), Also try to see if this feature already exists first [in the documentation](https://clementtsang.github.io/bottom/nightly/),
or if there's already an issue opened that covers this specific feature. or if there's already an issue opened that covers this specific feature.

2
README.md
View File

@ -299,7 +299,7 @@ More details on configuration can be found [in the documentation](https://clemen
## Troubleshooting ## Troubleshooting
If some things aren't working, give the [Troubleshooting page](https://clementtsang.github.io/bottom/nightly/troubleshooting) a look. If things still aren't If some things aren't working, give the [Troubleshooting page](https://clementtsang.github.io/bottom/nightly/troubleshooting) a look. If things still aren't
working, then consider asking a [question](https://github.com/ClementTsang/bottom/discussions) or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose). working, then consider asking a [question by opening a question](https://github.com/ClementTsang/bottom/discussions) or filing a [bug report](https://github.com/ClementTsang/bottom/issues/new/choose).
## Contribution ## Contribution