Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

96 lines (62 loc) · 3.35 KB
Raw

Contributing

Development workflow

To get started with the project, run yarn in the root directory to install the required dependencies:

yarn

We use storybook for components development. To run storybook execute

yarn dev

Linting and tests

We use TypeScript for type checking

yarn type-check

ESLint for linting the code

yarn lint

and Prettier for formatting the code

yarn format

[!TIP] Pre-commit hook

Our pre-commit hooks verify that the linter and format pass when committing.

We use Chromatic for visual testing and UI regression.

Our storybook is published to Chromatic and accessible by following: https://storybook.lw.iog.io/

Commit message convention

We follow the conventional commits specification for our commit messages:

  • fix: bug fixes, e.g. fix crash due to deprecated method.
  • feat: new features, e.g. add new method to the module.
  • docs: changes into documentation, e.g. add usage example for the module..
  • style: formatting, code style.
  • refactor: code refactor, e.g. migrate from class components to hooks.
  • test: adding or updating tests, e.g. add integration tests using detox.
  • ci: changes to continuous integration, pipelines, workflows.
  • chore: other changes not affecting functionality.

[!TIP] Pre-commit hook

Our pre-commit hooks verify that your commit message matches this format when committing.

How to write good commit message

Write the summary line of what you have done in the imperative mood, that is as if you were commanding someone.

Start the line with fix, add, change instead of fixed, added, changed.

Don’t end the summary line with a period..

Code Review

During the code review, we aim to improve the overall product quality.

  • Reviews should be concise and written in neutral language. Critique the code, not the author, and be respectful.
  • Over-communicate your thoughts in the initial message, as it saves time on back and forth communication cycles.

Merge Review

The PR commit messages plays an essential role in our versioning and publishing process. Rebase your branch with main to keep your code in sync and to have a linear commits history.

Create atomic commits which focuses on single thing at a time, and write good commit message, so it is self-contained and explanatory.

Versioning and Publishing

We follow semantic versioning and use semantic release for automatic versioning and publishing npm package to GitHub Package Registry.

Important

It's important to follow Commit message convention, so semantic-release can automatically determine the right version to be published to registry.

Useful links