Update CONTRIBUTING.md

pull/141/head
Arijit Basu 3 years ago committed by GitHub
parent 7f1d29f558
commit 67df321cd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,8 +1,18 @@
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 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).
- 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:
- To find issues you can help with, go though list of [good first issues](https://github.com/sayanarijit/xplr/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [help wanted](https://github.com/sayanarijit/xplr/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
- If you have something to suggest or issues to report, you can [create a new issue](https://github.com/sayanarijit/xplr/issues/new). 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.
- Once found or created an issue, let us know you want to work it by commenting in the issue.
Development Guideline
---------------------
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

Loading…
Cancel
Save