Skip to content

Contributing

Sergej edited this page May 2, 2019 · 4 revisions

Please read our Code of Conduct and Contribution guidelines

Pre-requisites

NodeJ

Flow

We use GitHub flow for collaborating on this project.

Working locally:

Install packages

npm i

Build

npm run build

Lint

npm run lint

Test

npm run test

Continuous Testing

npm run watch

Remember to increment package version before merging changes.
We are following SemVer.

npm version --no-git-tag-version %newVersion%

Publishing package

You need to be part of @justeat NPM organization.
Generate a user "Read and Publish" token on your profile page.

Set registry

npm config set registry https://registry.npmjs.org/

Set token for registry

npm config set //registry.npmjs.org/:_authToken=%MyToken%

Verify what you are about to publish (does not actually publish to NPM)

npm publish --access public --dry-run

If you are happy with the list of files from dry-run, publish to npm

npm publish --access public
Clone this wiki locally