Skip to content

Commit

Permalink
docs: add README.md file [#1]
Browse files Browse the repository at this point in the history
  • Loading branch information
d3p1 committed Aug 29, 2023
1 parent d4760ad commit b8b9306
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
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).

0 comments on commit b8b9306

Please sign in to comment.