Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

39 lines (23 loc) · 1.29 KB
Raw

Contributing

You can do code and documentation contributions.

Code

Setup

You need latest NodeJS (^10.5.0) use nvm and yarn (^1.7.0) as package manager.

git clone https://github.com/algolia/angular-instantsearch.git
cd angular-instantsearch

Run

You can access stories of Angular InstantSearch components by running the storybook with yarn examples:storybook.

There is also an e-commerce example consuming the built library and compliant to AOT (compiles your app at build time) compiler. It must be run to test the library in production before any PRs.

You can use > yarn examples:ecommerce and open http://localhost:4200 to access the e-commerce example.

Test

Tests are ran with jest and jest-preset-angular.

  • > yarn test -> run all tests
  • > yarn test:watch -> run tests and watch for changes

Releasing

To release a version, go on v3 (git checkout v3) and use:

yarn run release:prepare

It will create a pull request for the next release. When it's reviewed, approved and merged, then CircleCI will automatically publish it to npm.