@@ -13,9 +13,13 @@ bun install
1313## Commands
1414
1515``` bash
16- bun run build # Build the project
17- bun test # Run tests
18- bun run dev # Watch mode
16+ bun run build # Build the project
17+ bun test # Run tests
18+ bun test --coverage # Run tests with coverage
19+ bun run check # Lint + format check (Biome)
20+ bun run check:fix # Lint + format auto-fix
21+ bun run typecheck # Type check (tsc --noEmit)
22+ bun run dev # Watch mode
1923```
2024
2125## Making Changes
@@ -27,9 +31,11 @@ bun run dev # Watch mode
2731
28322 . Make your changes and add tests if applicable.
2933
30- 3 . Ensure all tests pass :
34+ 3 . Ensure everything passes before committing :
3135 ``` bash
32- bun test
36+ bun run check # Lint + format
37+ bun run typecheck # Type check
38+ bun test # Tests
3339 ```
3440
35414 . Commit using [ Conventional Commits] ( https://www.conventionalcommits.org/ ) :
@@ -41,14 +47,18 @@ bun run dev # Watch mode
4147 chore: update dependencies
4248 ```
4349
44- 5 . Open a Pull Request against ` main ` .
50+ 5 . Open a Pull Request against ` main ` . PR titles must follow the same conventional commit format.
4551
46- ## Code Style
52+ ## Code Quality
4753
48- - TypeScript with strict mode
49- - Use ` bun ` as the package manager and test runner
50- - Keep dependencies minimal
51- - Prefer explicit error handling over silent failures
54+ This project uses the following tools to maintain code quality:
55+
56+ - ** [ Biome] ( https://biomejs.dev/ ) ** for linting and formatting (replaces ESLint + Prettier)
57+ - ** TypeScript strict mode** for type safety
58+ - ** tsc --noEmit** for type checking beyond what Biome covers
59+ - ** bun test** with built-in coverage for testing
60+
61+ All checks run automatically in CI. PRs must pass the ` quality ` and ` test ` jobs before merging.
5262
5363## Project Structure
5464
@@ -75,6 +85,10 @@ Use the [bug report template](https://github.com/isanchez31/opencode-sandbox-plu
7585
7686Use the [ feature request template] ( https://github.com/isanchez31/opencode-sandbox-plugin/issues/new?template=feature_request.md ) .
7787
88+ ## Security
89+
90+ See [ SECURITY.md] ( SECURITY.md ) for reporting vulnerabilities.
91+
7892## License
7993
8094By contributing, you agree that your contributions will be licensed under the MIT License.
0 commit comments