Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I179 contribuing section in readme #180

Merged
merged 2 commits into from
Mar 23, 2018
Merged

I179 contribuing section in readme #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5860ab
Refs: #179; Adding Contributing guidelines to README.md
RobertDober Mar 22, 2018
992c327
Fixes: #179; Advert potential contibuters to not edit the generated p…
RobertDober Mar 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down