Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): contributions contents #2912

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# adapted out of https://github.com/h5bp/html5-boilerplate/blob/main/.gitattributes
# Automatically normalize line endings for all text-based files
# https://git-scm.com/docs/gitattributes#_end_of_line_conversion

* text=auto

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

# For the following file types, normalize line endings to LF on
# checkin and prevent conversion to CRLF when they are checked out
# (this is required in order to prevent newline related issues like,
# for example, after the build script is run)

.* text eol=lf
*.css text eol=lf
*.html text eol=lf
*.js text eol=lf
*.json text eol=lf
*.md text eol=lf
*.mjs text eol=lf
*.sh text eol=lf
*.txt text eol=lf
*.xml text eol=lf
*.yml text eol=lf
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Thanks for your interest in our project. Contributions are welcome. Feel free to [open an issue](https://github.com/db-ui/base/issues/new) with questions or reporting ideas and bugs, or [open pull requests](https://github.com/db-ui/base/compare) to contribute code.
Thanks for your interest in our project. Contributions are welcome. Feel free to [open an issue](https://github.com/db-ui/mono/issues/new) with questions or reporting ideas and bugs, or [open pull requests](https://github.com/db-ui/mono/compare) to contribute code.

We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!

Expand All @@ -12,4 +12,4 @@ Moreover, you need to duplicate `.env.template` as `.env` and type your own emai

### Conventions

Please be aware that we have some [code and git commit (message and branch naming) conventions](https://github.com/db-ui/core/blob/main/docs/conventions.adoc), that we ensure with some linting tools.
Please be aware that we have some [code and git commit (message and branch naming) conventions](https://github.com/db-ui/mono/blob/main/docs/conventions.md), that we ensure with some linting tools.
50 changes: 50 additions & 0 deletions docs/conventions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## 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.html#concept-commit-conventions>:

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

[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

The general code conventions are guaranteed by the following tools.

### Through configuration files: `.editorconfig` for IDEs and `.gitattributes` for git checkins
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.

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

## Linting

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

### yaml files via yamllint

- [yamllint.readthedocs.io](https://yamllint.readthedocs.io/)

### markdown files via markdownlint

- [github.com/markdownlint/markdownlint](https://github.com/markdownlint/markdownlint/)
Loading