# Contributing
Thanks for wanting to help make Limitless better!
## Project layout
```
src/
main.rs # CLI entry, argument routing, help text
lib.rs # public crate facade + VERSION constant
models.rs # shared types (EnvironmentState, HealthScore, ...)
modules/
stack_detector.rs # stack detection by project markers
diagnostics.rs # deep environment diagnostics
runtime_validator.rs # runtime version checks
env_auditor.rs # .env / .env.example audit
port_watcher.rs # port + process scan
dependency_checker.rs# dependency manifest health
translator.rs # cryptic error → plain English
message_formatter.rs # mentor advice boxes
tui.rs # dashboard rendering
progress.rs # spinner / progress bar
fixes.rs # individual fixes + execution
auto_fix.rs # fix orchestration & reports
planetary.rs # sci-fi dashboard
arcade.rs # typing game
achievements.rs # badges + persistence
config.rs # ~/.limitless persistence
utils/
tests/
fixtures/ # mock projects for tests
integration_test.rs # end-to-end tests
```
## Setup
```bash
git clone https://github.com/limitless-cli/limitless.git
cd limitless
# Windows note: the repo pins the x86_64-pc-windows-gnu target and mingw gcc
# via .cargo/config.toml. Install MSYS2 mingw-w64-x86_64-gcc and make sure
# C:\msys64\mingw64\bin is on your PATH.
cargo test # unit + integration + doc tests
cargo clippy --all-targets -- -D warnings # must stay clean
cargo build --release
```
## Workflow
1. Fork the repo and create a feature branch.
2. Make your change. Keep it small and focused.
3. Add/update tests. Every module carries its own `#[cfg(test)] mod tests`.
New behavior needs a test; bug fixes need a regression test.
4. Run the full suite and clippy; both must be green.
5. Open a pull request describing the change and referencing any issue.
## Style
- Follow the existing module conventions (see any `modules/**/*.rs`).
- No comments unless they explain *why* (the code should explain *what*).
- Favor plain-English user-facing strings; this tool exists for beginners.
- Keep tests hermetic: use the fixtures in `tests/fixtures/`, temp dirs, or
canned output. Never hit the network or kill real processes in tests.
## Release process
Maintainers tag releases and the CI/CD workflow builds, tests, lints, and
publishes (see `.github/workflows/ci.yml`):
```bash
git tag -a v1.0.0 -m "Release 1.0.0"
git push origin v1.0.0
cargo publish # crates.io (after the tag CI passes)
```
Update `CHANGELOG.md` before tagging.
## License
MIT. By contributing you agree to license your work under the same terms.