Adding a note about small pull requests.

This commit is contained in:
Strahinja Val Markovic 2014-03-19 15:51:44 -07:00
parent 28663c191d
commit 999a1902eb

View File

@ -81,12 +81,16 @@ Creating good pull requests
_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
3. **Split your pull request into several smaller ones if possible.** This
makes it easier to review your changes, which means they will be merged
faster.
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.
4. **Explain in detail why your pull request makes sense.** Ask yourself, would
5. **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 YCMs
users? See, good features are useful to many. If your feature is only useful
to you and _maybe_ a couple of others, then thats not a good feature.
@ -103,7 +107,7 @@ Creating good pull requests
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?_
5. **Sign the Google [Contributor License Agreement][cla]** (you can sign
6. **Sign the Google [Contributor License Agreement][cla]** (you can sign
online at the bottom of that page). You _must_ sign this form, otherwise we
cannot merge in your changes. **_Always_ mention in the pull request that
you've signed it**, even if you signed it for a previous pull request (you