diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..92edbc7 --- /dev/null +++ b/CONTRIBUTING.md @@ -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