diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2022-01-29 11:49:41 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-29 14:49:41 -0500 |
| commit | 61c8bfd5748997a22626b05b0f2d8e202aa1c0b0 (patch) | |
| tree | 0b17377d86383ffaf5b785e0207aaea8475b7910 | |
| parent | 6c989785fb458a8d7933f98050148e0faf45a8ba (diff) | |
docs: add a line to feature request docs/template (#666)
Just adds an extra line to the template/docs to check if an existing issue already exists.
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 3 | ||||
| -rw-r--r-- | docs/content/contribution/issues-and-pull-requests.md | 5 |
2 files changed, 5 insertions, 3 deletions
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9cd22817..27adb20b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,4 +11,5 @@ assignees: "" Please describe what behaviour you are looking for, the motivation for it, and use cases for where this feature would be helpful. Try to be clear and concise - more details are usually helpful, but don't ramble on too much. -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. diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md index 36ebb57c..d4ba805a 100644 --- a/docs/content/contribution/issues-and-pull-requests.md +++ b/docs/content/contribution/issues-and-pull-requests.md @@ -6,13 +6,14 @@ Contribution in any way is appreciated, whether it is reporting problems, fixing ### Bug reports -When filing a bug report, please use the [bug report template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and fill in as much as you can. It is _incredibly_ difficult for a maintainer to fix -a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem! +When filing a bug report, please use the [bug report template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and fill in as much as you can. It is _incredibly_ difficult for a maintainer to fix a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem! ### Feature requests Please use the [feature request template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=feature&template=feature_request.md&title=) and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful. +Also please check whether or not an existing issue has covered your specific feature request! + ## Pull requests The expected workflow for a pull request is: |