## Contributing

We are always welcoming your contribution :clap:

---

<p align="center">
   <strong><a href="#requirements">Requirements</a></strong>
   |
   <strong><a href="#setup">Setup</a></strong>
   |
   <strong><a href="#running-lintingtests">Running linting/tests</a></strong>
</p>

---

## Developing

### Requirements

- [rust-clippy](https://github.com/rust-lang/rust-clippy)
- [cargo-insta](https://crates.io/crates/cargo-insta)

### Setup

Fork the `promptuity` repository to your GitHub Account.

Then, run:

```bash
$ git clone https://github.com/<your-github-username>/promptuity
$ cd promptuity
```

### Running linting/tests

You can run test via:

```bash
$ cargo test
```

When new snapshots are generated by `insta`, a review is conducted.

```bash
$ cargo insta review
```

<details>
<summary>Test Workflow</summary>

```bash
$ cargo test; cargo insta review
```
</details>

You can run lint via:

```bash
$ cargo clippy
```