From f5860ab8ec6a07a0d923c1e78321fefe7570ab33 Mon Sep 17 00:00:00 2001
From: RobertDober <robert.dober@gmail.com>
Date: Thu, 22 Mar 2018 10:05:28 +0100
Subject: [PATCH 1/2] Refs: #179; Adding Contributing guidelines to README.md

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index d72c7d15..5b95baf8 100644
--- a/README.md
+++ b/README.md
@@ -422,6 +422,25 @@ but just to demonstrate the possibilities):
       {:ok, "<ul>\n<li>one\n</li>\n<li>two\n</li>\n</ul>\n* one* two", []}
 <!-- endmoduledoc: Earmark.Plugin -->
 
+## Contributing
+
+Pull Requests are happily accepted.
+
+Please be aware of one _caveat_ when correcting/improving README.md.
+
+Parts of the README.md are automatically generated by the mix task `readme`.
+
+The generated parts are delimited by comment pairs like
+
+    <!-- moduledoc: Earmark -->
+    <!-- endmoduledoc: Earmark -->
+
+or
+
+    <!-- doc: Earmark.as_html -->
+    <!-- enddoc: Earmark.as_html -->
+
+Please modify the associated docstrings instead.
 
 ## Author
 

From 992c32728a5b963d7a0669593bd477a032137921 Mon Sep 17 00:00:00 2001
From: RobertDober <robert.dober@gmail.com>
Date: Thu, 22 Mar 2018 18:49:58 +0100
Subject: [PATCH 2/2] Fixes: #179; Advert potential contibuters to not edit the
 generated parts of README but the associated docstrings, generating them

---
 README.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/README.md b/README.md
index 5b95baf8..a10ddaf8 100644
--- a/README.md
+++ b/README.md
@@ -427,9 +427,7 @@ but just to demonstrate the possibilities):
 Pull Requests are happily accepted.
 
 Please be aware of one _caveat_ when correcting/improving README.md.
-
 Parts of the README.md are automatically generated by the mix task `readme`.
-
 The generated parts are delimited by comment pairs like
 
     <!-- moduledoc: Earmark -->