Skip to content

Commit 88821b6

Browse files
mfranzkeCopilot
andauthored
fix(docs): contributions contents (#2912)
* docs: contributions Some URLs we're pointing to another repository * Create conventions.md * Update CONTRIBUTING.md * Create .gitattributes * Update conventions.md * Update CONTRIBUTING.md * Update conventions.md * Update conventions.md * Update docs/conventions.md Co-authored-by: Copilot <[email protected]> * Update conventions.md * Update .gitattributes * Update conventions.md --------- Co-authored-by: Copilot <[email protected]>
1 parent 64f8e68 commit 88821b6

File tree

2 files changed

+55
-6
lines changed

2 files changed

+55
-6
lines changed

.gitattributes

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# adapted out of https://github.com/h5bp/html5-boilerplate/blob/main/.gitattributes and https://rehansaeed.com/gitattributes-best-practices/
2+
# Automatically normalize line endings for all text-based files
3+
# https://git-scm.com/docs/gitattributes#_end_of_line_conversion
4+
5+
###############################
6+
# Git Line Endings #
7+
###############################
8+
9+
# Set default behaviour to automatically normalize line endings.
10+
* text=auto
11+
12+
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
13+
14+
# For the following file types, normalize line endings to LF on
15+
# checkin and prevent conversion to CRLF when they are checked out
16+
# (this is required in order to prevent newline related issues like,
17+
# for example, after the build script is run)
18+
19+
.* text eol=lf
20+
*.css text eol=lf
21+
*.html text eol=lf
22+
*.js text eol=lf
23+
*.json text eol=lf
24+
*.md text eol=lf
25+
*.mjs text eol=lf
26+
*.sh text eol=lf
27+
*.txt text eol=lf
28+
*.xml text eol=lf
29+
*.yml text eol=lf

docs/conventions.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
## Git commits conventions
22

3-
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>:
3+
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>:
44

55
```text
66
type(scope?): subject
77
body?
88
footer?
99
```
1010

11-
> Type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]
11+
[Type must be one of the following](https://commitlint.js.org/reference/rules.html#type-enum):
1212

13-
source: [commitlint documentation](https://commitlint.js.org/#/?id=test)
13+
- build
14+
- chore
15+
- ci
16+
- docs
17+
- feat
18+
- fix
19+
- perf
20+
- refactor
21+
- revert
22+
- style
23+
- test
1424

1525
If you'd like to test your commit message previous to using it, you could test it on the command line:
1626

17-
```terminal
27+
```shell
1828
echo 'foo: bar' | commitlint
1929
```
2030

@@ -26,10 +36,20 @@ The general code conventions are guaranteed by the following tools.
2636

2737
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.
2838

39+
### prettier
40+
41+
The [prettier](https://github.com/db-ui/core/blob/main/docs/adr/code_style_formatter-prettier.adoc) tool provides a general code prettifying.
42+
43+
## Linting
44+
2945
### xo
3046

3147
The [xo](https://github.com/db-ui/core/blob/main/docs/adr/linting-xo.adoc) tool provides a general code linting mechanism.
3248

33-
### prettier
49+
### yaml files via yamllint
50+
51+
- [yamllint.readthedocs.io](https://yamllint.readthedocs.io/)
52+
53+
### markdown files via markdownlint
3454

35-
The [prettier](https://github.com/db-ui/core/blob/main/docs/adr/code_style_formatter-prettier.adoc) tool provides a general code prettfying.
55+
- [github.com/markdownlint/markdownlint](https://github.com/markdownlint/markdownlint/)

0 commit comments

Comments
 (0)