-
Notifications
You must be signed in to change notification settings - Fork 1
how to contribute
khanhthanhdev edited this page Jun 1, 2026
·
1 revision
Infi is currently a solo-contributor project, but the codebase is structured to accept contributions. This guide covers the intended workflow for anyone looking to help.
-
Browse open issues on the GitHub repository. Issues labeled
good first issueare scoped for newcomers. - Claim the issue by leaving a comment. This avoids duplicate effort.
-
Fork the repository and create a feature branch from
main.
If there is no issue for the work you want to do, open one first. Describe the problem or feature, and wait for acknowledgment before starting.
- Fork and branch from
main. - Write code following the patterns and conventions.
- Run all validation commands before pushing (see Development Workflow).
- Open a pull request against
mainwith:- A description of the user-visible change
- The validation commands you ran and their results
- Screenshots or recordings for UI changes
- A link to any related issue
- A maintainer will review the PR. Address feedback promptly.
A change is ready to merge when all of these pass with zero warnings:
Frontend:
cd frontend && bun run check:ci # Biome lint + format
cd frontend && bun run build # TypeScript type-checkRust:
cargo fmt --check # Formatting
cargo clippy --all-targets --all-features -- -D warnings # Lint
cargo test # All tests passDo not push code that produces warnings. Fix all clippy lints, Biome issues, and type errors before requesting review.
- Patterns and Conventions — coding style, naming, and architectural rules
- Testing — how to run and write tests
- Tooling — build system, linters, formatters, and CI
- Development Workflow — branch strategy and validation cycle