diff options
| author | Іван Потієнко <[email protected]> | 2025-11-30 01:23:51 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-11-30 01:23:51 +0200 |
| commit | ad2cc94fcfa9945d703d92e51958d6526bb4da98 (patch) | |
| tree | 45f8e434e3dbd3b60803d3a369c6d5a24185d939 /README.md | |
| parent | b4a16e57b51ae2b6d15f521c76b4446267d75c5d (diff) | |
| download | mikusays-c-ad2cc94fcfa9945d703d92e51958d6526bb4da98.tar.gz mikusays-c-ad2cc94fcfa9945d703d92e51958d6526bb4da98.zip | |
Revise development section in README.md
Updated development instructions for contributing to the project.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 32 insertions, 4 deletions
@@ -84,7 +84,35 @@ cargo build --release ## Development -```bash -cargo build -cargo run -- "message" -``` +1. Fork repository +2. Clone your fork +3. Implement your changes +4. If needed, write tests (it would be great) +5. Run your code with your changes + ```bash + cargo run -- [your implemented methods, or just text if it's ASCII only]. + ``` +7. Run the tests + ```bash + cargo test + ``` +8. Check your code quality with: + ```bash + cargo clippy -- -D warnings + ``` + Fix any errors that appear + +10. Finally, run the formatter: + ```bash + cargo fmt + ``` +11. Commit and push your changes +12. Open a pull request + +Now you're a contributor! + +<div align=center> + +<img height="124" src="https://github.com/user-attachments/assets/f3d4e4e8-0fa4-40a1-bc89-aafbbd896a73" /> + +</div> |
