Merge pull request #180 from pragdave/i179-contribuing-section-in-readme

I179 contribuing section in readme
pragdave · Mar 23, 2018 · f222d88 · f222d88
2 parents 84dcd59 + 992c327
commit f222d88
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -422,6 +422,23 @@ 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