Skip to content

Commit 3041b93

Browse files
author
km-kwon
committed
DOCS: test Coverage contents are added in README.md
1 parent 05316e5 commit 3041b93

2 files changed

Lines changed: 856 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,44 @@ class RollingAverage {
430430

431431
---
432432

433+
## Testing
434+
435+
This package includes comprehensive test coverage using Vitest and React Testing Library.
436+
437+
### Running Tests
438+
439+
```bash
440+
# Run all tests
441+
npm test
442+
443+
# Run tests with coverage
444+
npm run test:coverage
445+
```
446+
447+
### Test Coverage
448+
449+
The project maintains high test coverage:
450+
451+
- **CircularBuffer**: 100% coverage (32 tests)
452+
- **BufferManager**: 100% coverage (47 tests)
453+
- **React Hook (useCircularBuffer)**: 100% coverage (29 tests)
454+
455+
Total: **108 tests** across 3 test suites
456+
457+
Coverage reports are generated in the `coverage/` directory. Open `coverage/index.html` in your browser to view detailed coverage information.
458+
459+
### CI/CD
460+
461+
This project uses GitHub Actions for continuous integration:
462+
463+
- **Automated Testing**: Tests run on Node.js 18, 20, and 22
464+
- **Build Verification**: Ensures TypeScript compilation succeeds
465+
- **Coverage Reporting**: Automatic upload to Codecov
466+
467+
See [.github/workflows/ci.yml](.github/workflows/ci.yml) for the complete CI configuration.
468+
469+
---
470+
433471
## Changelog
434472

435473
See [CHANGELOG.md](CHANGELOG.md) for version history and release notes.

0 commit comments

Comments
 (0)