Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 1.83 KB

Contributing

First of all, thanks for contributing! You can check out the issues tagged with "difficulty: easy ❄️" for a start.

Get ready for contributions

You'll first need to install the dependencies:

yarn install

Then we recommend that you run:

yarn test:watch

This will watch the files for changes and build the CommonJS bundle that is required by the tests. It will the run the test on that newly generated build.

Commit format

The project uses conventional commit format to automate the updates of the CHANGELOG.md.

Releasing the library

To release the library, the first step is to create a "release PR" by running:

bin/release-branch.sh

This will ask you the new version of the library, and update all the required files accordingly. We use git add --patch on updated files to give you the opportunity to review the changes. In general all you need to do is accept all of them by pressing y multiple times.

At the end of the process, the release branch is pushed to GitHub where you can open the Pull Request.

Once the changes are approved you can merge it there.

You can now fetch the latest changes from the remote master branch and run:

bin/publish.sh

This will:

  • publish the new version on NPM
  • tag and push the tag to GitHub

Documentation

You can either directly click on "EDIT ON GITHUB" links on the live documentation: https://community.algolia.com/vue-instantsearch/.

Or you can run the documentation locally:

$ npm run docs:watch

Deploying documentation

The documentation is automatically deployed on temporary URLs by netlify on pull requests.

To release the documentation to the community website, you can run:

yarn run docs:deploy