Skip to content

Commit

Permalink
Refs: #179; Adding Contributing guidelines to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertDober committed Mar 22, 2018
1 parent abc7b55 commit f5860ab
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit f5860ab

Please sign in to comment.