CONTRIBUTING.md (1582B)
1 # Contributing 2 3 Rad Roots is an open-source application repository. 4 Contributions are welcome, including bug fixes, UI improvements, tests, and documentation updates. 5 6 ## Scope 7 8 This repository currently ships a single-package GPUI bootstrap application named `radroots_app`. 9 Keep the filetree small and direct until a larger application boundary is justified. 10 11 ## Prerequisites 12 13 Install the pinned Rust toolchain: 14 15 ```bash 16 rustup toolchain install 1.92.0 17 rustup override set 1.92.0 18 ``` 19 20 Confirm your environment: 21 22 ```bash 23 cargo --version 24 rustc --version 25 ``` 26 27 ## Development Commands 28 29 Run these commands from the repository root. 30 31 ```bash 32 cargo metadata --format-version 1 --no-deps 33 cargo check -p radroots_app 34 cargo test 35 cargo run -p radroots_app 36 ./scripts/check.sh 37 ./scripts/run.sh 38 ``` 39 40 ## Contribution Guidelines 41 42 - Keep changes scoped to a single coherent change. 43 - Prefer small, reviewable commits. 44 - Update tests when behavior changes. 45 - Update documentation when commands or structure change. 46 - Use repository-relative paths in contributor-facing text. 47 - Remove obsolete code and dependencies when they are clearly replaced. 48 49 ## Reporting Issues 50 51 When reporting a bug, include: 52 53 - your operating system and version 54 - Rust toolchain version 55 - the command you ran 56 - the observed behavior 57 - the expected behavior 58 59 ## Submitting Changes 60 61 1. Create a branch for your change. 62 2. Make the smallest coherent update that solves the issue. 63 3. Run the relevant validation commands from this document. 64 4. Open a pull request with a clear summary of what changed and how it was verified.