arnekeller/cursive
1
0
Fork 0
mirror of https://github.com/FliegendeWurst/cursive.git synced 2024-09-18 17:55:11 +00:00
Code Issues Projects Releases Wiki Activity

Create CONTRIBUTING.md

Browse Source
This commit is contained in:
Alexandre Bury 2017-06-14 16:45:20 -07:00 committed by GitHub
parent 19f87076f9
commit c9a73f21ed
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md Normal file
View File

@ -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.