Skip to content

Commit a797ad7

Browse files
authored
docs: update contribution docs (#2018)
1 parent 6122daa commit a797ad7

3 files changed

Lines changed: 14 additions & 6 deletions

File tree

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ _Ensure **all** of these are met:_
3333
- [ ] _The change has been tested to work (see above) and doesn't appear to break other things_
3434
- [ ] _Documentation has been updated if needed (`README.md`, help menu, docs, configs, etc.)_
3535
- [ ] _There are no merge conflicts_
36-
- [ ] _You have reviewed the changes first_
36+
- [ ] _You have reviewed your changes first_
3737
- [ ] _The pull request passes the provided CI pipeline_
3838

3939
## Other

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,26 @@ Please fill out the [feature request template](https://github.com/ClementTsang/b
1515

1616
## Pull requests
1717

18-
If you want to directly contribute documentation changes or code, follow this! The expected workflow for a pull request is:
18+
The expected workflow for a pull request is:
1919

2020
1. Fork the project.
2121
2. Make your changes.
2222
3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://bottom.pages.dev/nightly/contribution/documentation/) for tips on documentation.
23-
4. Commit and create a pull request to merge into the `main` branch. **Please fill out the pull request template**.
23+
4. Commit and create a pull request to merge into the `main` branch. **Please fill out the pull request template and checklist**.
2424
5. Ask a maintainer to review your pull request.
2525
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a
2626
first-time contributor, you may need to wait for a maintainer to let CI run.
2727
- If changes are suggested or any comments are made, they should probably be addressed.
28-
6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, though
28+
6. Once it looks good, it'll be merged! Note that generally, PRs are squashed to maintain repo cleanliness, though
2929
feel free to ask otherwise if that isn't preferable.
3030

31+
Some other things related to making changes or pull requests:
32+
33+
- Please review your code _yourself_ before you create the PR and ask for a review.
34+
- I'm fine if you use AI to help with your change, but I expect you to still review the changes yourself.
35+
- If you are adding or changing any dependency, I expect a justification on why this is necessary.
36+
- Please ensure that any changes made are compatible with the license of bottom.
37+
3138
For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/).
3239

3340
### Documentation

docs/content/contribution/issues-and-pull-requests.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,12 @@ The expected workflow for a pull request is:
3131
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a
3232
first-time contributor, you may need to wait for a maintainer to let CI run.
3333
- If changes are suggested or any comments are made, they should probably be addressed.
34-
6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, though
34+
6. Once it looks good, it'll be merged! Note that generally, PRs are squashed to maintain repo cleanliness, though
3535
feel free to ask otherwise if that isn't preferable.
3636

3737
Some other things related to making changes or pull requests:
3838

3939
- Please review your code _yourself_ before you create the PR and ask for a review.
40-
- If you're using AI to help with your changes, fine, but I expect you to still review the code yourself.
40+
- I'm fine if you use AI to help with your change, but I expect you to still review the changes yourself.
4141
- If you are adding or changing any dependency, I expect a justification on why this is necessary.
42+
- Please ensure that any changes made are compatible with the license of bottom.

0 commit comments

Comments
 (0)