Contributions of all kinds are welcome and appreciated!
- Report bugs — open an issue describing what went wrong and how to reproduce it
- Suggest features — open an issue describing the use case and expected behavior
- Improve documentation — fix typos, clarify wording, or add examples
- Submit code — bug fixes, new features, or performance improvements
- Search existing issues first to avoid duplicates
- Use the appropriate issue template (bug report or feature request)
- Be as specific as possible — include versions, OS, and reproduction steps for bugs
-
Fork and clone the repository:
git clone https://github.com/<your-username>/leetrs.git cd leetrs
-
Create a new branch:
git checkout -b feat/your-feature-name
-
Make your changes and add appropriate unit / integration tests.
-
Format the code:
cargo xtask fmt # or: cargo fmt --all -
Run the CI quality gate:
leetrsprovides a unified task runner (xtask) to run all checks locally before pushing:cargo xtask ci
This executes:
- 🔍 Format check:
cargo fmt --all --check - 🔍 Clippy linter:
cargo clippy --all-targets -- -D warnings - 🧪 Unit tests:
cargo test
You can also run individual tasks as needed:
cargo xtask fmt(orcargo xtask fmt --check)cargo xtask clippy— Run Clippy with-D warningscargo xtask test— Run the unit test suitecargo xtask coverage --html— Generate and view code coverage report (requirescargo install cargo-llvm-cov)
- 🔍 Format check:
-
Commit your changes: Commit messages must follow Conventional Commits (e.g.,
feat(tui): add topic search,fix(client): handle rate limits). If your PR resolves an issue, reference it in the commit body / PR description (e.g.,Closes #14). -
Push to your fork:
git push origin feat/your-feature-name
-
Open a Pull Request against the
mainbranch. Ensure the checklist is completed and all automated CI checks pass.