Archives/xplr
2
0
Fork 0
mirror of https://github.com/sayanarijit/xplr synced 2024-11-10 07:10:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Arijit Basu 2021-05-11 17:24:09 +05:30 committed by GitHub
parent 82b975c5f0
commit 7f1d29f558
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
CONTRIBUTING.md Normal file
View File

@ -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.