docs: document testing and coverage requirements

2025-12-25 04:13:09 -07:00
parent 3a184154db
commit 2672d47203
2 changed files with 15 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -43,8 +43,15 @@ The system allows you to:
 Run unit tests using Jest:
 ```bash
 npm test
+```bash
+npm test
 ```

+### Code Quality Enforcement
+This project uses **Husky** to enforce code quality locally.
+- **Pre-commit Hook**: Runs tests on changed files before every commit.
+- **Coverage Requirement**: Modified files must maintain **80% code coverage**. Commits will be blocked if this threshold is not met.
+
 ## Project Structure

 - `src/`: Source code (TypeScript)