Skip to content

Commit 43db5e9

Browse files
authored
Merge pull request #4 from automa/pavan/jj/puxvvtwuoqrr
Added CONTRIBUTING.md
2 parents 168ac85 + 4d0ec3c commit 43db5e9

2 files changed

Lines changed: 38 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# How to Contribute
2+
3+
## Prerequisites
4+
5+
- Have [`rust` & `cargo`](https://www.rust-lang.org/) installed.
6+
7+
## Installing dependencies
8+
9+
```sh
10+
cargo check
11+
```
12+
13+
## Running the tool
14+
15+
```sh
16+
cargo run
17+
```
18+
19+
## CI/CD
20+
21+
#### Testing
22+
23+
```sh
24+
cargo test
25+
```
26+
27+
#### Linting
28+
29+
```sh
30+
cargo lint
31+
```
32+
33+
#### Formatting
34+
35+
```sh
36+
cargo format
37+
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Please see [CHANGELOG.md](CHANGELOG.md).
6262

6363
<!-- omit from toc -->
6464
## Contributing
65-
Contributions and feedback are welcome! Feel free to open an issue or submit a pull request.
65+
Contributions and feedback are welcome! Feel free to open an issue or submit a pull request. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
6666

6767
Here is a list of [Contributors](http://github.com/automa/cli/contributors).
6868

0 commit comments

Comments
 (0)