Skip to content

Commit

Permalink
docs: update contributing and ready
Browse files Browse the repository at this point in the history
  • Loading branch information
martinmcwhorter committed Feb 7, 2020
1 parent 8629bac commit 1f2502f
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This project aims to be open to contributions.

Please take a look at our open issues and see if you can help.

## Reporting Bugs

- Be sure the issue you are reporting has not already been reported.
Expand Down
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,57 @@ Update `package.json` Commitizen configuration.
},
```

## Purpose

The purpose of this project is to have a single configuration for both `commitlint` and `commitizen` -- while prompting the user for each answer.

## Similar Projects

Both of these wonderful projects are use the `commitlint` config as well.

- [@commitlint/prompt](https://www.npmjs.com/package/@commitlint/prompt)
- [@commitlint/prompt-cli](https://www.npmjs.com/package/@commitlint/prompt-cli)

Commitiquette differs by using simple prompts, list selects whenever possible, for answers -- much like the `cz-conventional-changelog` commitizen plugin.

## Fully Configurable

Commitiquitte is fully configurable using the `commitlint` configuration.

Examples

### Disable Prompting for scope

```javascript
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'scope-empty': [2, 'always']
}
};
```

### List select for scope

```javascript
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'scope-enum': [2, 'always', ['docs', 'core', 'lib', 'misc', 'etc']]
}
};
```

## Filtering and Validation

Commitiquette will validate against all but the deprecated `commitlint` rules.

> **NOTE:** This is not a replacement for `commitlint`. Commitlint should still validate the message before each commit.
Where possible, commitlint rules will be used to filter messages.

Validation is run at Level Error (2) -- where filtering will apply at if the rule is set to Warn (1) or Error (2.)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Expand Down

0 comments on commit 1f2502f

Please sign in to comment.