maud/CONTRIBUTING.md
Chris Wong d04a2c6a01
Document that the doctest crate might need updating ()
Also rename the "Examples" build to "Doctest" to clarify what it does.
2022-04-10 20:29:41 +10:00

18 lines
599 B
Markdown

# Contributing to Maud
Great to see that you want to help out! Here are some tips for getting started:
* Please leave a comment on the issue you're working on, so that other people don't duplicate work.
* Most contributions should include [tests] and a [changelog entry].
* If you're adding or updating a web framework integration, you might need to update the [doctest crate].
* Want to work on documentation? See the [docs readme] for advice on that.
Have fun! ☺️
[tests]: maud/tests
[changelog entry]: CHANGELOG.md
[doctest crate]: doctest/Cargo.toml
[docs readme]: docs/README.md