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

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Alexandre Bury 2017-06-14 23:55:11 -07:00 committed by GitHub
parent c9a73f21ed
commit d11cbebf53
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ Here are a few guidelines to help make sure your contribution goes as smoothly a
This is still a young library, and bugs are sure to be hiding everywhere. If you found one, great! 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. * Mention the operating system you are using. If you are manually selecting a backend (for instance termion), 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. * 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. * If relevant, you can post a screenshot describing the problem.
@ -23,3 +23,4 @@ If you feel like digging in the code, thank you again! We're very grateful for y
* Format your code with rustfmt. * 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. * 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. * Only use stable rust features. This library should compile on rust stable.
* Do one thing at a time. Split a large change into a series of smaller, standalone changes. Don't start a refactor while adding a feature.