lee/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2026-07-08 13:40:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add AI policy to contribution docs (#2135)

Browse Source
This commit is contained in:
Clement Tsang
2026-07-07 22:43:04 -04:00
committed by GitHub
parent e5f13d17fc
commit c05f6e3ec7
3 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+4 -2
View File
@@ -31,8 +31,6 @@ The expected workflow for a pull request is:
Some other things related to making changes or pull requests:
- Please review your code _yourself_ and test your changes before you create the PR and ask for a review.
- I'm fine with AI assistance, but I expect you to still review the changes before creating the PR.
- I also expect to be talking with a human if I have questions or comments - if I wanted to talk to an AI agent to make a change, I can do that myself.
- If you are adding or changing any dependency, a justification on why this is necessary must be included.
- Please ensure that any changes made are compatible with the license of bottom.
@@ -46,3 +44,7 @@ For contributing to documentation, see [here](https://bottom.pages.dev/nightly/c
If you want to become a package maintainer, see [here](https://bottom.pages.dev/nightly/contribution/packaging-and-distribution/)
for details on how to build bottom, how to generate/obtain completion files and manpages, and how to add installation instructions for the package to the README.
## AI Policy
Note that any contribution, whether it be opening an issue, PRs, or commenting, should follow the [AI policy](./AI_POLICY.md). Contributions that do not follow this may be closed/hidden.
docs/content/contribution/documentation.md
+5
View File
@@ -55,3 +55,8 @@ There are a few areas where documentation changes are often needed:
3. Once you have your documentation changes done, submit it as a pull request. For more information regarding that,
refer to [Issues, Pull Requests, and Discussions](issues-and-pull-requests.md).
## AI Policy
Documentation should _never_ be generated by AI. The point of documentation in this project is to communicate things between humans. Follow the [AI policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md); changes that do not follow it
may be closed or hidden.
docs/content/contribution/issues-and-pull-requests.md
+4 -2
View File
@@ -37,7 +37,9 @@ The expected workflow for a pull request is:
Some other things related to making changes or pull requests:
- Please review your code _yourself_ and test your changes before you create the PR and ask for a review.
- I'm fine with AI assistance, but I expect you to still review the changes before creating the PR.
- I also expect to be talking with a human if I have questions or comments - if I wanted to talk to an AI agent to make a change, I can do that myself.
- If you are adding or changing any dependency, a justification on why this is necessary must be included.
- Please ensure that any changes made are compatible with the license of bottom.
## AI Policy
Note that any contribution, whether it be opening an issue, PRs, or commenting, should follow the [AI policy](https://github.com/ClementTsang/bottom/blob/main/AI_POLICY.md). Contributions that do not follow this may be closed/hidden.