Skip to content

Commit

Permalink
Update conventions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mfranzke authored Jul 25, 2024
1 parent db8548a commit cf82741
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions docs/conventions.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
## Git commits conventions

We're using [husky git hooks](https://www.npmjs.com/husky) in combination with [commitlint](https://www.npmjs.com/package/@commitlint/cli) according to <https://commitlint.js.org/#/concepts-commit-conventions>:
We're using [husky git hooks](https://www.npmjs.com/husky) in combination with [commitlint](https://www.npmjs.com/package/@commitlint/cli) according to <https://commitlint.js.org/concepts/commit-conventions.html#concept-commit-conventions>:

````
```text
type(scope?): subject
body?
footer?
````

> quote, commitlint documentation
```

Source: <https://commitlint.js.org/#/?id=test>
____
> Type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]
____
[Type must be one of the following](https://commitlint.js.org/reference/rules.html#type-enum):
- build
- chore
- ci
– docs
- feat
- fix
- perf
- refactor
- revert
- style
- test

If you'd like to test your commit message previous to using it, you could test it on the command line:
```shell
echo 'foo: bar' | commitlint
```
````

## Code conventions

Expand Down

0 comments on commit cf82741

Please sign in to comment.