Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.42 KB
Raw

How to contribute?

We use ESLint

We use ESLint to enforce JS coding style and spot linting errors ASAP. Our configuration is based on standardJS + some small tweaks (see .eslintrc.js).

You can run the lint check with:

npm run lint

You can run the lint check (with autofix) with:

npm run lint:fix

We have precise rules for commit message format

Commit messages must respect conventional commit.

Possible types are fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:.

The scope should be the name of the command affected. If many commands are affected, consider the following options:

  • split into multiple commits
  • avoid specifying any scope and add some details instead. However, you must understand that details won't be dumped into the CHANGELOG.

If none of these options suits your need, you can follow this how-to that will let you generate multiple CHANGELOG entries with one single commit.

To help you respect the rules, you should install a commit linter with the following command:

cd ${PATH_TO_THE_REPOSITORY_ROOT}
git config core.hooksPath '.githooks'

You must understand that nothing will be dumped into the CHANGELOG if you don't respect these rules.