lee/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2026-07-09 06:01:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update contribution documentation (#2087)

Browse Source
This commit is contained in:
Clement Tsang
2026-06-18 03:53:40 -04:00
committed by GitHub
parent 1ffde3a6f3
commit 7916c918fd
3 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/pull_request_template.md
+3 -2
View File
@@ -30,11 +30,12 @@ _Ensure **all** of these are met:_
- [ ] _If this is a code change, your changes pass `cargo clippy --all -- -D warnings`_
- [ ] _If this is a code change, new tests were added if relevant_
- [ ] _If this is a code change, your changes pass `cargo test`_
- [ ] _The change has been tested to work (see above) and doesn't appear to break other things_
- [ ] _The change has been verified to work (see the Testing section) and doesn't unexpectedly break anything else_
- [ ] _Documentation has been updated if needed (`README.md`, help menu, docs, configs, etc.)_
- [ ] _There are no merge conflicts_
- [ ] _You have reviewed your changes first_
- [ ] _You have personally reviewed your changes already before creating the PR_
- [ ] _The pull request passes the provided CI pipeline_
- [ ] _If this PR was generated with AI, please specify how in the "Other" section, and that you as a human have personally reviewed it_
## Other
CONTRIBUTING.md
+4 -3
View File
@@ -30,9 +30,10 @@ The expected workflow for a pull request is:
Some other things related to making changes or pull requests:
- Please review your code _yourself_ before you create the PR and ask for a review.
- I'm fine if you use AI to help with your change, but I expect you to still review the changes yourself.
- If you are adding or changing any dependency, I expect a justification on why this is necessary.
- 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.
For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/).
docs/content/contribution/issues-and-pull-requests.md
+4 -3
View File
@@ -36,7 +36,8 @@ The expected workflow for a pull request is:
Some other things related to making changes or pull requests:
- Please review your code _yourself_ before you create the PR and ask for a review.
- I'm fine if you use AI to help with your change, but I expect you to still review the changes yourself.
- If you are adding or changing any dependency, I expect a justification on why this is necessary.
- 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.