hello/CONTRIBUTING.md
| 1 | # Contributing |
| 2 | |
| 3 | Thanks for helping improve `hello`. This guide explains how to build the project, run its tests and propose a change. |
| 4 | |
| 5 | ## Build |
| 6 | |
| 7 | 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`. |
| 8 | |
| 9 | ```sh |
| 10 | cargo build |
| 11 | ``` |
| 12 | |
| 13 | To try your changes, run the binary through Cargo: |
| 14 | |
| 15 | ```sh |
| 16 | cargo run -- --shout Ada |
| 17 | ``` |
| 18 | |
| 19 | ## Test |
| 20 | |
| 21 | ```sh |
| 22 | cargo test |
| 23 | ``` |
| 24 | |
| 25 | ## Propose a change |
| 26 | |
| 27 | 1. Fork the repository and clone your fork. |
| 28 | 2. Create a branch for your change. |
| 29 | 3. Make a focused change that does one thing, and add or update tests for it. |
| 30 | 4. Run `cargo test` and make sure it passes. |
| 31 | 5. If you add or change a flag, update the usage section in `README.md`. |
| 32 | 6. Add an entry under Unreleased in `CHANGELOG.md`. |
| 33 | 7. Open a pull request that describes what you changed and why. |