Contributing
Thank you for helping improve medhira-react-typescript-hooks.
Development setup
git clone https://github.com/HELLOMEDHIRA/medhira-react-typescript-hooks.git
cd medhira-react-typescript-hooks
npm install
Commands
| Command | Purpose |
|---|---|
npm test |
Run Jest tests |
npm run lint |
ESLint |
npm run build |
Compile ESM + CJS to dist/ |
npm run prettier |
Format src/ and tests/ |
Pull request checklist
- Fork the repository and create a feature branch.
- Add or update tests for behavior changes.
- Run
npm testandnpm run lint. - Update docs in
docs/when the public API changes. - Open a PR with a clear description and test plan.
Docs (MkDocs)
pip install -r requirements.txt
mkdocs serve
Documentation is built on Read the Docs; do not commit the site/ build folder.
Contact
- Email: hello.medhira@gmail.com
- GitHub: HELLOMEDHIRA