Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radumarias authored Aug 6, 2024
1 parent 6eb3392 commit d699cf1
Showing 1 changed file with 3 additions and 17 deletions.
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,23 +189,9 @@ python examples/mlock.py

# Contribute

Feel free to fork it, change and use it in any way that you want. If you build something interesting and feel like sharing pull requests are always appreciated.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache License, shall be dual-licensed as above, without any additional terms or conditions.
Feel free to fork it, change and use it in any way that you want.
If you build something interesting and feel like sharing pull requests are always appreciated.

## How to contribute

1. Fork the repo
2. Make the changes in your fork
3. Add tests for your changes, if applicable
4. `cargo build --workspace --all-targets --all-features` and fix any issues
5. `cargo fmt --all`, you can configure 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 --workspace --all-targets` and fix any errors and warnings
7. `cargo clippy --all-targets` and fix any errors
8. `cargo test --all-targets --all-features` and fix any issues
9. Create a PR
10. Monitor the checks (GitHub actions run)
11. Respond to any comments
12. In the end ideally it will be merged to `main`
Please see [CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit d699cf1

Please sign in to comment.