Thank you for your interest in contributing to RepoProof! We welcome contributions of all kinds: bug reports, feature requests, documentation improvements, and code changes.
- Fork the repository on GitHub.
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/repoproof.git cd repoproof - Install dependencies:
pnpm install
- Verify everything works:
pnpm verify
| Command | Description |
|---|---|
pnpm build |
Build the project |
pnpm dev |
Watch mode with auto-rebuild |
pnpm test |
Run tests |
pnpm test:watch |
Run tests in watch mode |
pnpm test:coverage |
Run tests with coverage report |
pnpm lint |
Lint source files |
pnpm format |
Format source files |
pnpm format:check |
Check formatting |
pnpm typecheck |
Run TypeScript type checking |
pnpm smoke |
Run smoke tests against fixtures |
pnpm verify |
Run typecheck, lint, format check, test, build, and smoke test |
src/
├── cli/ # CLI entry point (commander-based)
├── config/ # Configuration loading and validation
├── engine/ # Scanner, rule runner, and scoring
├── reporters/ # Output formatters (text, json, html, markdown, sarif)
├── rules/ # Rule implementations (one file per rule)
└── types.ts # Shared TypeScript types and interfaces
- Create a new file in
src/rules/following the existing pattern. - Export a
ruleconstant that conforms to theRuleinterface. - Import and add it to the
rulesarray insrc/rules/index.ts. - Add tests in
src/rules/__tests__/. - Document the rule in
docs/rules.md.
- TypeScript — strict mode, no
anyunless absolutely necessary - No commented code — remove it instead
- No TODO/FIXME markers — fix or track in issues
- ESM — use
import/exportwith.jsextensions - No external dependencies beyond
commanderandstrip-ansi
- Tests use Vitest and are colocated in
__tests__directories. - Each rule should have tests for positive cases (triggers correctly) and negative cases (no false positives).
- Run
pnpm testbefore submitting.
- Create a feature branch from
main. - Make your changes, adding tests and documentation.
- Run
pnpm verifylocally to ensure all checks pass. - Open a pull request with a clear description of the change.
- Ensure the PR description explains what problem it solves and how.
This project follows a Code of Conduct. By participating, you agree to uphold its standards.
Open an issue or start a discussion on GitHub. We're happy to help!