diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 59dd12be..f7e8033e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,5 +1,5 @@ name: Feature request -description: Got a good idea that hasn't already been suggested? Mention it here! +description: Got a good idea that hasn't already been suggested? Mention it here! labels: [ "feature" ] body: - type: checkboxes diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ca3eaa45..3630ceca 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,7 +7,7 @@ _A description of the change, what it does, and why it was made. If relevant (e. ## Issue -_If applicable, what issue does this address?_ +_If applicable, what issue does this address? Note that if this is for a new feature, please create an issue first and let it be discussed first. PRs that do not follow this may be closed._ Closes: # @@ -36,7 +36,10 @@ _Ensure **all** of these are met:_ - [ ] _There are no merge conflicts_ - [ ] _You have personally reviewed your changes already before creating the PR_ - [ ] _The pull request passes the provided CI pipeline_ -- [ ] _If the changes were generated with AI tools, ensure it follows the [AI policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md). Specify how it was used in the "Other" section, and that you as a human have personally reviewed the change_ +- _If the changes were generated with AI tools:_ + - [ ] _Ensure it **fully** follows the [AI policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md)._ + - [ ] _Specify how it was used in the "Other" section._ + - [ ] _Ensure that you, as a human, have personally reviewed the change_ ## Other diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md index b658667a..2d729990 100644 --- a/docs/content/contribution/issues-and-pull-requests.md +++ b/docs/content/contribution/issues-and-pull-requests.md @@ -15,12 +15,14 @@ When filing a bug report, please use the [bug report template](https://github.co ### 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 an existing issue has covered your specific feature request! +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 first! Also, please check whether an existing issue +already covers your specific feature request. ## Pull requests +**Note**: if you want to add a new feature, please first open an appropriate issue to discuss the merits of the feature. +PRs that do not do this may be closed. + The expected workflow for a pull request is: 1. Fork the project.