From c9a73f21edca6b6b75407b68acb4cb76f45e170f Mon Sep 17 00:00:00 2001 From: Alexandre Bury Date: Wed, 14 Jun 2017 16:45:20 -0700 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..52b42a2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +Thank you so much for helping on cursive! + +Here are a few guidelines to help make sure your contribution goes as smoothly as possible. + +## You found a bug + +This is still a young library, and bugs are sure to be hiding everywhere. If you found one, great! + +* Please mention the operating system you are using. If you are manually selecting a backend, please mention this as well. +* Try to provide "simple" (if possible) code to reproduce the bug. If you can't simplify your code, a complete code is better than a simple, but incomplete one. +* If relevant, you can post a screenshot describing the problem. + +## Improvement idea + +If you have an idea you think would make this library better, we're all ears! + +* Describe your use-case: what do you want to achieve with this improvement? + +## Pull requests + +If you feel like digging in the code, thank you again! We're very grateful for your work. + +* Format your code with rustfmt. +* Make sure all tests are passing - it's very easy to forget a backend! If you start a Pull Request, travis will check all backends for you. +* Only use stable rust features. This library should compile on rust stable.