Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MartenBE authored Nov 30, 2024
1 parent 54a685e commit 5894194
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributing guidelines

Thank you very much for contributing! Every help is welcome :).

## Workflow

If you have a bugfix, feel free to create a PR. If you have a feature request you can open an issue (or a PR if you already have code).

## Code guidelines

Here are some guidelines we ask to follow:

- The used language is English.
- Files should be UTF-8.
- Everything should come with as much [tests](./tests) as possible.
- The readability of code is very important.
- Formatting and linting is checked in the PR, please adhere to these checks. You can check the [CI/CD pipeline](./.github/workflows/test-deploy.yml) for the exact checks.

0 comments on commit 5894194

Please sign in to comment.