diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b73e4ea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# How to contribute + +PRs are very welcome! + +## Adding code + +- Create a fork +- Create a branch +- Do your thing +- [Please sign all your commits](https://docs.github.com/de/authentication/managing-commit-signature-verification) +- Create a PR + - Reference issues if applicable + +## Found a bug? + +- Please open an issue +- If you are able to fix it you also can open a PR (see above) diff --git a/README.md b/README.md index 4435e6c..4b2bd79 100644 --- a/README.md +++ b/README.md @@ -48,3 +48,7 @@ main- ``` `latest` should be self-explanatory. The `main` tags are built with every push to the main branch and can be regarded as development tags. + +## How to contribute? + +see [CONTRIBUTING.md](CONTRIBUTING)