CONTRIBUTING.md

Contributing to okidoc

Tests

To run tests for projects, use npm run test from root project.

Commit Message Guidelines

We use conventionalcommits to format our commit messages. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the okidoc release notes.

Release New Version

To release new version:

• checkout latest master version:

> git checkout master
> git pull

• run npm preparePublish from repo root (based on lerna version):

> npm run preparePublish

• ensure changelog generated correctly and commit changes if any.
• push master branch and tags:

> git push origin master
> git push origin [NEW_VERSION_TAG]

• draft a new release on github with changelog from previous steps
• after CI released new package, publish release on github