xplr/CONTRIBUTING.md
2021-05-11 17:24:09 +05:30

929 B

If you are new to GitHub, visit the first-contributions instructions to learn how to contribute on GitHub.

If you are new to Rust, I recommend you to go through the book.

Assuming you have forked and cloned the repo locally, in order to contribute by making changes to the code follow the steps below:

  • Make changes to the code

  • Test the changes

cargo run

cargo test
  • Format code and get linting helps
cargo fmt

cargo clippy
  • Commit, push and finally create a pull request.

  • Don't worry if you make a mistake, we will provide constructive feedback and guidance to improve the pull request.

  • If you encounter any situation that violates our code of conduct or please report it to sayanarijit@gmail.com.