vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More logical ordering of points in contrib docs

Browse Source
This commit is contained in:
Strahinja Val Markovic 2013-11-17 10:42:51 -08:00
parent bf7451ff98
commit f46f4cbbe0
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -77,7 +77,16 @@ Creating good pull requests
match the code style you see. match the code style you see.
- Same thing for VimScript. Match the style of the existing code. - Same thing for VimScript. Match the style of the existing code.
2. **Explain in detail why your pull request makes sense.** Ask yourself, would 2. **Your code needs to be well written and easy to maintain**. This is of the
_utmost_ importance. Other people will have to maintain your code so don't
just throw stuff against the wall until things kinda work.
3. **Write tests for your code**. If you're changing the VimScript code then
you don't have to since it's hard to test that code. This is also why you
should strive to implement your change in Python if at all possible (and if
it makes sense to do so). Python is also _much_ faster than VimScript.
4. **Explain in detail why your pull request makes sense.** Ask yourself, would
this feature be helpful to others? Not just a few people, but a lot of YCM’s this feature be helpful to others? Not just a few people, but a lot of YCM’s
users? See, good features are useful to many. If your feature is only useful users? See, good features are useful to many. If your feature is only useful
to you and _maybe_ a couple of others, then that’s not a good feature. to you and _maybe_ a couple of others, then that’s not a good feature.
@ -94,14 +103,5 @@ Creating good pull requests
sometimes what you want can be done in a different way if the reason for the sometimes what you want can be done in a different way if the reason for the
change is known. _What goal is your change trying to accomplish?_ change is known. _What goal is your change trying to accomplish?_
3. **Your code needs to be well written and easy to maintain**. This is of the
_utmost_ importance. Other people will have to maintain your code so don't
just throw stuff against the wall until things kinda work.
4. **Write tests for your code**. If you're changing the VimScript code then
you don't have to since it's hard to test that code. This is also why you
should strive to implement your change in Python if at all possible (and if
it makes sense to do so). Python is also _much_ faster than VimScript.
[build-bots]: https://travis-ci.org/Valloric/YouCompleteMe [build-bots]: https://travis-ci.org/Valloric/YouCompleteMe
[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users [ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users