Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.55 KB

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.

Development workflow

To get started with the project, install the required dependencies by running:

npm i

OR

yarn

The README FILE demonstrates the usage of the library. You need to run it to test any changes you make.

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 a new method to the module.
  • refactor: code refactor, e.g. migrate from class components to hooks.
  • docs: changes into documentation, e.g. add usage example for the module.
  • test: adding or updating tests, e.g. adding integration tests.
  • chore: tooling changes, e.g. change CI config.

Linting

ESLint, Prettier

Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify linting.
  • Review the documentation to make sure it looks good.