diff options
author | ClementTsang <cjhtsang@uwaterloo.ca> | 2022-06-05 18:29:14 -0400 |
---|---|---|
committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2022-06-05 18:29:14 -0400 |
commit | d0cb61a4c21518fb771ea53ed7af7b1ef2cda42d (patch) | |
tree | 1edfd483520ed5ff6f55db5076c95dc7a72c681c /.github | |
parent | c1a7979be7e7635b241d2cfe72726525f495dddb (diff) |
docs: some small updates to README and issue templates
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 2 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 4 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 1 |
3 files changed, 5 insertions, 2 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e9eb95d0..aaa93cd4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. +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! ## Describe the bug diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7741570d..7e906a84 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ blank_issues_enabled: true contact_links: - - name: Ask a question + - name: Open a discussion 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 27adb20b..d37ad7d5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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/), or if there's already an issue opened that covers this specific feature. + |