From 4fe59f97b428e2fd82010a49f0d1faed7e43a254 Mon Sep 17 00:00:00 2001
From: Robert Waffen <rw@betadots.de>
Date: Fri, 8 Mar 2024 14:07:55 +0100
Subject: [PATCH] add CONTRIBUTING.md

---
 CONTRIBUTING.md | 21 +++++++++++++++++++++
 README.md       |  9 ++++++---
 2 files changed, 27 insertions(+), 3 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..1176db94
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+# 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](https://github.com/betadots/hdm/issues)
+- If you are able to fix it, you also can open a PR (see above)
+
+## Have an idea?
+
+- Please start a [discussion](https://github.com/betadots/hdm/discussions)
diff --git a/README.md b/README.md
index 68343f94..9c10ebe7 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Copyright 2023 betadots GmbH
 
 This Rails application displays [Puppet](https://github.com/puppetlabs/puppet) Hiera data and offers a WebGUI to read/update/create that configuration.
 
-You can find screenshots in the [screenshots](screenshots) directory.
+You can find screenshots in the [screenshots](SCREENSHOTS.md).
 
 ## Manual installation
 
@@ -124,7 +124,7 @@ want to make sure that your repository is only edited by HDM.
 
 Don't forget to set SECRET_KEY_BASE env var in docker run, docker-compose, systemd or hieradata.
 
-```
+```shell
 openssl rand -hex 16
 9dea7603c008dec285e4b231602a00b2
 
@@ -136,7 +136,6 @@ docker run -it --rm -p 3000:3000 -e DEVELOP=1 -e SECRET_KEY_BASE=9dea7603c008dec
 
 See [`docker-compose.yaml`](docker-compose.yaml).
 
-
 ### Update db file
 
 Move existing db/development.sqlite3 to db/production.sqlite3
@@ -146,3 +145,7 @@ docker exec -it <container_id> bash
 mv db/development.sqlite3 db/production.sqlite3
 bin/rails db:environment:set RAILS_ENV=production
 ```
+
+## How to contribut?
+
+see [CONTRIBUTING.md](CONTRIBUTING.md)