Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #141

Merged
merged 1 commit into from
Aug 8, 2024
Merged

Update CONTRIBUTING.md #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
save, [RustRover](https://www.jetbrains.com/help/rust/rustfmt.html)
and [VSCode](https://code.visualstudio.com/docs/languages/rust#_formatting)
11. `cargo clippy --all --release` and fix any erorrs
12. **MAKE SURE YOU RUN THIS BEFORE PUSHING TO THE REPO `./check-before-push.sh` or `cmd /c check-before-push.bat` and fix any errors**
13. Create a **PR** back to the **parent** repo targeting the `main` branch
14. Monitor the checks (GitHub actions run) and fix the code if they are failing
15. Respond to any comments
16. In the end, ideally, it will be merged to `main`
12. **DON'T INCREASE THE VERSION NUMBER IN `Cargo.toml`, WE WILL DO THAN WHEN RELEASING**
13. **MAKE SURE YOU RUN THIS BEFORE PUSHING TO THE REPO `./check-before-push.sh` or `cmd /c check-before-push.bat` and fix any errors**
14. Create a **PR** back to the **parent** repo targeting the `main` branch
15. Monitor the checks (GitHub actions run) and fix the code if they are failing
16. Respond to any comments
17. In the end, ideally, it will be merged to `main`
Loading