Contributing

Thank you for your interest in contributing to HTML Flip Book!

Development Setup

Clone the repository:

git clone https://github.com/DoradSoft/html-flip-book.git
cd html-flip-book

Install dependencies:
```
npm install
```

Install pre-commit hooks:

pip install pre-commit
pre-commit install

Start development:
```
npm run dev
```

Commands

Task	Command
Build	`npm run build`
Unit Tests	`npm test`
E2E Tests	`npm run test:e2e`
Lint & Format	`npx biome check --write .`
Generate Docs	`npm run docs`

Guidelines

Follow the existing code style (Biome formatting)
Write tests for new features
Add JSDoc comments for public APIs (auto-generates docs)
Keep commits focused and descriptive

Bug Fix Workflow (Red-Green TDD)

Write a failing test that exposes the bug
Verify the test fails
Fix the bug
Verify the test passes
Run the full test suite

Pull Requests

Create a feature branch from master
Make your changes

Bump the version:

cd base && npm version patch --no-git-tag-version
cd ../react && npm version patch --no-git-tag-version

Submit a PR

License

By contributing, you agree that your contributions will be licensed under the MIT License.