Contributing Rules

To start using this rules validator just install this package using npm.

npm install crules

Running this command will display the list of rules to be following for a predefined set of rules.

Currently there is no way to modify this rules, but we will work on customizable settings.

Use case

This is recommended to use within a pre-commit hook, e.g. husky

"husky": {
  "hooks": {
    "pre-commit": "crules"
  }
}

CLI Check Points

This will guide the developer for a correct contribution in the project.

• Self Code Review
• Documentation Changes