Skip to content

Commit

Permalink
Update conventions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mfranzke authored Nov 27, 2024
1 parent cc2a34f commit d6c2914
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/conventions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Git commits conventions

We're using link:https://www.npmjs.com/husky[husky git hooks] in combination with link:https://www.npmjs.com/package/@commitlint/cli[commitlint] 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>:

....
type(scope?): subject
Expand All @@ -23,10 +23,10 @@ echo 'foo: bar' | commitlint
The general code conventions are guaranteed by the following tools.

### Through configuration files: `.editorconfig` for IDEs and `.gitattributes` for git checkins
Both the link:https://editorconfig.org/[`.editorconfig`] and link:https://dev.to/deadlybyte/please-add-gitattributes-to-your-git-repository-1jld[`.gitattributes`] ensure a consistent code structure and conventions through their configurations.
Both the [`.editorconfig`](https://editorconfig.org/) and [`.gitattributes`](https://dev.to/deadlybyte/please-add-gitattributes-to-your-git-repository-1jld) ensure a consistent code structure and conventions through their configurations.

### xo
The link:adr/linting-xo.adoc[xo] tool provides a general code linting mechanism.
The [xo](adr/linting-xo.adoc) tool provides a general code linting mechanism.

### prettier
The link:adr/code_style_formatter-prettier.adoc[prettier] tool provides a general code prettfying.

0 comments on commit d6c2914

Please sign in to comment.