Skip to content

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

  1. Fork the repository and create a feature branch.
  2. Add or update tests for behavior changes.
  3. Run npm test and npm run lint.
  4. Update docs in docs/ when the public API changes.
  5. 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