-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<div align=center> | ||
|
||
# [CONVENTIONAL COMMITS PARSER] | ||
|
||
</div> | ||
|
||
## Introduction | ||
|
||
Just a little [shareable configuration](https://commitlint.js.org/#/reference-configuration) for [commitlint](https://commitlint.js.org/) to be able to validate the addition of an issue number to the end of a commit message that follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. | ||
|
||
The commit message structure must be: | ||
|
||
``` | ||
<type>(<scope>): <description> [<issue-number>] | ||
``` | ||
|
||
Where: | ||
|
||
- `<type>` is mandatory | ||
- `<scope>` is optional | ||
- `<description>` is mandatory | ||
- `<issue-number>` is mandatory | ||
|
||
## Usage | ||
|
||
Just extend this configuration from your [commitlint configuration object](https://commitlint.js.org/#/reference-configuration?id=configuration-object-example) using the `extends` option. For example, create a `commitlint.config.js` file with the following content: | ||
|
||
```js | ||
module.exports = { | ||
extends: ['@d3p1/commitlint-config-conventional'] | ||
}; | ||
``` | ||
|
||
## Author | ||
|
||
Always happy to receive a greeting on: | ||
|
||
- [LinkedIn](https://www.linkedin.com/in/cristian-marcelo-de-picciotto/) | ||
- [Twitter](https://twitter.com/___d3p1) | ||
|
||
|
||
## License | ||
|
||
This work is published under [MIT License](license). |