First of all, thanks for wanting to help out with InstantSearch 🎉!
Here's some information you can use to contribute to InstantSearch
Currently we support React and plain JavaScript (or Vanilla) via:
- ⚛ React and React Native ➡️ React InstantSearch
- 🍦 Vanilla ➡️ InstantSearch.js
We use the documentation website as the main way to develop React InstantSearch.
yarn boot
yarn start
Go to http://localhost:3000.
We have unit tests for all packages/
:
yarn test # one shot run, also lint and tries to build the documentation
yarn dev # unit tests watch mode, no lint
yarn lint # only changed files in dev, all files in CI
yarn lint:fix
npm run release
This cannot yet be moved to yarn release
so please use npm run release
.
yarn docs:deploy-production
yarn docs:deploy-preview
This uses netlify.
yarn upgrade-deps
yarn changelog