diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c4f28ef --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# How to Contribute + +## Prerequisites + +- Have [`rust` & `cargo`](https://www.rust-lang.org/) installed. + +## Installing dependencies + +```sh +cargo check +``` + +## Running the tool + +```sh +cargo run +``` + +## CI/CD + +#### Testing + +```sh +cargo test +``` + +#### Linting + +```sh +cargo lint +``` + +#### Formatting + +```sh +cargo format +``` diff --git a/README.md b/README.md index c9f7c5c..eeb9c3b 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Please see [CHANGELOG.md](CHANGELOG.md). ## Contributing -Contributions and feedback are welcome! Feel free to open an issue or submit a pull request. +Contributions and feedback are welcome! Feel free to open an issue or submit a pull request. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. Here is a list of [Contributors](http://github.com/automa/cli/contributors).