Skip to content

Added CONTRIBUTING.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pksunkara merged 1 commit into from
Jun 24, 2025
Merged

Added CONTRIBUTING.md #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Please see [CHANGELOG.md](CHANGELOG.md).

<!-- omit from toc -->
## 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).

Expand Down