maud/CONTRIBUTING.md
2017-11-19 20:12:38 +13:00

20 lines
977 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Contributing to Maud
Great to see that you want to help out! Here are some tips for getting started:
* If you're just starting out, I suggest tackling some [easy issues] first.
* Please leave a comment on the issue you're working on, so that other people don't duplicate work.
* Most contributions should include tests see the [existing test code] for how to write these.
* Documentation on the proc macro interface can be found on [docs.rust-lang.org][proc_macro].
- As for lints: [Manishearth's site] provides documentation for compiler internals.
Have fun! ☺️
[easy issues]: https://github.com/lfairy/maud/issues?q=is%3Aissue+is%3Aopen+label%3A%22difficulty%3A+easy%22
[existing test code]: https://github.com/lfairy/maud/tree/master/maud/tests
[proc_macro]: https://doc.rust-lang.org/nightly/proc_macro/
[compiler source]: https://github.com/rust-lang/rust/tree/master/src
[Manishearth's site]: https://manishearth.github.io/rust-internals-docs/rustc/