hello/CONTRIBUTING.md
# Contributing
Thanks for helping improve `hello`. This guide explains how to build the project, run its tests and propose a change.
## Build
The crate is written in Rust (2021 edition). The logic lives in `src/lib.rs` (`parse_args`), the entry point is `src/main.rs`, and integration tests are in `tests/cli.rs`.
```sh
cargo build
```
To try your changes, run the binary through Cargo:
```sh
cargo run -- --shout Ada
```
## Test
```sh
cargo test
```
## Propose a change
1. Fork the repository and clone your fork.
2. Create a branch for your change.
3. Make a focused change that does one thing, and add or update tests for it.
4. Run `cargo test` and make sure it passes.
5. If you add or change a flag, update the usage section in `README.md`.
6. Add an entry under Unreleased in `CHANGELOG.md`.
7. Open a pull request that describes what you changed and why.