diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b3180f7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +If you are new to GitHub, visit the [first-contributions instructions](https://github.com/firstcontributions/first-contributions/blob/master/README.md) to learn how to contribute on GitHub. + +If you are new to Rust, I recommend you to go through [the book](https://doc.rust-lang.org/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 + +```bash +cargo run + +cargo test +``` + +- Format code and get linting helps + +```bash +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](https://github.com/sayanarijit/xplr/blob/main/CODE_OF_CONDUCT.md) or please report it to sayanarijit@gmail.com.