Thanks for your interest in contributing!
git clone https://github.com/devlens/devlens.git
cd devlens
npm install
npm run build| Command | Description |
|---|---|
npm run build |
Compile TypeScript |
npm run dev |
Run CLI in dev mode |
npm test |
Run tests |
npm run test:watch |
Watch mode |
npm run test:coverage |
Test coverage report |
npm run lint |
Lint code |
npm run format |
Format code |
npm run typecheck |
Type check |
Write tests for all new features. Tests live in tests/unit/. Use the fixture repositories in tests/fixtures/ for reproducible test cases.
- TypeScript with strict mode
- Biome for formatting and linting
- Single quotes, semicolons, trailing commas
- No
anywithout good reason
- Create
src/analyzer/languages/<lang>/ - Implement the complexity, duplication, and file analysis functions
- Register the language in
config/defaults.ts - Add tests and fixtures
- Fork the repository
- Create a feature branch
- Add tests for your changes
- Ensure all tests pass:
npm test - Ensure linting passes:
npm run lint - Submit a pull request
By contributing, you agree that your contributions will be licensed under the MIT License.