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.
To find issues you can help with, go though the list of good first issues or issues labeled with help wanted.
If you have something to suggest or issues to report, you can create a new issue. Be sure to explain in details the context and the outcome that you are lookign for. If reporting bugs, provide basic information like you OS version, xplr version, window manager and the terminal you are using.
Once found or created an issue, let us know that you want to work on it by commenting in the issue.
Assuming that you have mentioned the issue you are working on and that you have forked and cloned the repository 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 please report it to [email protected].