From 999a1902eb67fc5c5a1a8eb9af8949612a95c2fd Mon Sep 17 00:00:00 2001 From: Strahinja Val Markovic Date: Wed, 19 Mar 2014 15:51:44 -0700 Subject: [PATCH] Adding a note about small pull requests. --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b00d3f5..2483a380 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 YCM’s 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. @@ -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