From d0cb61a4c21518fb771ea53ed7af7b1ef2cda42d Mon Sep 17 00:00:00 2001 From: ClementTsang Date: Sun, 5 Jun 2022 18:29:14 -0400 Subject: [PATCH] docs: some small updates to README and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 ++ .github/ISSUE_TEMPLATE/config.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 1 + README.md | 2 +- 4 files changed, 6 insertions(+), 3 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. + diff --git a/README.md b/README.md index bb647f6c..e9189f8b 100644 --- a/README.md +++ b/README.md @@ -299,7 +299,7 @@ More details on configuration can be found [in the documentation](https://clemen ## 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 -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