Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 1.74 KB

React InstantSearch logo

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:

Development

We use the documentation website as the main way to develop React InstantSearch.

yarn boot
yarn start

Go to http://localhost:3000.

Test

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

Lint

yarn lint # only changed files in dev, all files in CI
yarn lint:fix

Release

npm run release

This cannot yet be moved to yarn release so please use npm run release.

Update docs

yarn docs:deploy-production

Deploy a preview of docs

yarn docs:deploy-preview

This uses netlify.

Upgrade deps

yarn upgrade-deps

See next release changelog

yarn changelog