Add contributors' guide

This commit is contained in:
Chris Wong 2016-10-22 20:36:48 +13:00
parent 90e0f1ccbd
commit 927a77f0f6

17
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,17 @@
# 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 for Rust compiler APIs can be found on [Manishearth's site].
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_macros/tests
[Manishearth's site]: https://manishearth.github.io/rust-internals-docs/syntax/index.html