From bc7cddb9cc0e7504fc72672b60f9cbe8ee40a06c Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@geeklabor.de>
Date: Sat, 26 Dec 2020 16:56:06 +0100
Subject: [PATCH] docs: add contributing information

---
 .drone.jsonnet  |  4 ++--
 .drone.yml      |  6 +++---
 CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++
 README.md       |  3 ++-
 4 files changed, 38 insertions(+), 6 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/.drone.jsonnet b/.drone.jsonnet
index 46f7b00..d604c6d 100644
--- a/.drone.jsonnet
+++ b/.drone.jsonnet
@@ -288,7 +288,7 @@ local PipelineDocs = {
       image: 'node:lts-alpine',
       commands: [
         'npm install -g markdownlint-cli',
-        "markdownlint 'docs/content/**/*.md' 'README.md'",
+        "markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md'",
       ],
       environment: {
         FORCE_COLOR: true,
@@ -300,7 +300,7 @@ local PipelineDocs = {
       image: 'node:lts-alpine',
       commands: [
         'npm install -g spellchecker-cli',
-        "spellchecker --files 'docs/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions",
+        "spellchecker --files 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions",
       ],
       environment: {
         FORCE_COLOR: true,
diff --git a/.drone.yml b/.drone.yml
index 8476bdb..a8259ed 100644
--- a/.drone.yml
+++ b/.drone.yml
@@ -495,7 +495,7 @@ steps:
   image: node:lts-alpine
   commands:
   - npm install -g markdownlint-cli
-  - markdownlint 'docs/content/**/*.md' 'README.md'
+  - markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md'
   environment:
     FORCE_COLOR: true
     NPM_CONFIG_LOGLEVEL: error
@@ -504,7 +504,7 @@ steps:
   image: node:lts-alpine
   commands:
   - npm install -g spellchecker-cli
-  - spellchecker --files 'docs/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions
+  - spellchecker --files 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions
   environment:
     FORCE_COLOR: true
     NPM_CONFIG_LOGLEVEL: error
@@ -664,6 +664,6 @@ depends_on:
 
 ---
 kind: signature
-hmac: e6019acabf9aa621c86476cf604105cfdee5a58d6c0cbea069b9159f180ecf24
+hmac: efe34a2b218e5db05f9608c0ab25e90352a70bcaaf802a6419d192dda8ac0cdc
 
 ...
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..c471f59
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# Contributing
+
+## Security
+
+If you think you have found a **security issue**, please do not mention it in this repository.
+Instead, send an email to security@thegeeklab.de with as many details as possible so it can be handled confidential.
+
+## Bug Reports and Feature Requests
+
+If you have found a **bug** or have a **feature request** please use the search first in case a similar issue already exists.
+If not, please create an issue in this repository
+
+## Code
+
+If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request.
+
+Before you start any Pull Request, it is recommended that you create an issue to discuss first if you have any
+doubts about requirement or implementation. That way you can be sure that the maintainer(s) agree on what to change and how,
+and you can hopefully get a quick merge afterwards.
+
+Pull Requests can only be merged once all status checks are green.
+
+## Do not force push to your Pull Request branch
+
+Please do not force push to your Pull Requests branch after you have created your Pull Request, as doing so makes it harder for us to review your work.
+Pull Requests will always be squashed by us when we merge your work. Commit as many times as you need in your Pull Request branch.
+
+## Re-requesting a review
+
+Please do not ping your reviewer(s) by mentioning them in a new comment. Instead, use the re-request review functionality.
+Read more about this in the [GitHub docs, Re-requesting a review](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#re-requesting-a-review).
diff --git a/README.md b/README.md
index 770cb3d..0e0dd4b 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,8 @@ You can find the full documentation at [https://docker-tidy.geekdocs.de](https:/
 
 ## Contributors
 
-Special thanks goes to all [contributors](https://github.com/thegeeklab/docker-tidy/graphs/contributors).
+Special thanks goes to all [contributors](https://github.com/thegeeklab/docker-tidy/graphs/contributors). If you would like to contribute,
+please see the [instructions](https://github.com/thegeeklab/docker-tidy/blob/master/CONTRIBUTING.md).
 
 ## License