Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radumarias committed Jun 13, 2024
1 parent 00d72c6 commit 67f5eba
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -960,14 +960,13 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
1. Fork the repo
2. Make the changes in your fork
3. Add tests for your changes, if applicable
4. `RUSTFLAGS: "-Dwarnings"` set this before you run `cargo` commands, one time per terminal or add it to your `rc` file
5. `cargo build --all --all-features` and fix any issues
6. `cargo fmt --all`, you can cnofigure your IDE to do this on save [RustRover](https://www.jetbrains.com/help/rust/rustfmt.html) and [VSCode](https://code.visualstudio.com/docs/languages/rust#_formatting)
7. `cargo check --all --all-features` and fix any errors and warnings
8. `cargo clippy --all --all-features` and fix any errors
9. `cargo test --all --all-features` and fix any issues
10. `cargo bench --all --all-features` and fix any issues
11. Create a PR
12. Monitor the checks (GitHub actions runned)
13. Respond to any comments
14. In the end ideally it will be merged to `main`
4. `cargo build --all --all-features` and fix any issues
5. `cargo fmt --all`, you can cnofigure your IDE to do this on save [RustRover](https://www.jetbrains.com/help/rust/rustfmt.html) and [VSCode](https://code.visualstudio.com/docs/languages/rust#_formatting)
6. `cargo check --all --all-features` and fix any errors and warnings
7. `cargo clippy --all --all-features` and fix any errors
8. `cargo test --all --all-features` and fix any issues
9. `cargo bench --all --all-features` and fix any issues
10. Create a PR
11. Monitor the checks (GitHub actions runned)
12. Respond to any comments
13. In the end ideally it will be merged to `main`

0 comments on commit 67f5eba

Please sign in to comment.