You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,19 +15,26 @@ Please fill out the [feature request template](https://github.com/ClementTsang/b
15
15
16
16
## Pull requests
17
17
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:
19
19
20
20
1. Fork the project.
21
21
2. Make your changes.
22
22
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**.
24
24
5. Ask a maintainer to review your pull request.
25
25
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a
26
26
first-time contributor, you may need to wait for a maintainer to let CI run.
27
27
- 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
29
29
feel free to ask otherwise if that isn't preferable.
30
30
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
+
31
38
For more details, see [here](https://bottom.pages.dev/nightly/contribution/issues-and-pull-requests/).
0 commit comments