We love open source and are blown away when people volunteer their time and proffer us code as pull requests. We must emphasize however that the most important thing to us is the quality and robustness of our products.
Thus we kindly request you provide us with concise, minimal pull requests. This means:
- Keep them on point1
- The shorter the better2
- Avoid moving code around unnecessarily3
- Force push rather than merge when
mainadvances4
Footnotes
-
We know it’s hard to avoid tweaking this and that as you work, but unfortunately anything that is not specific to the purpose of the pull request is distracting and increases the likelihood the review will be delayed or we’ll make mistakes. ↩
-
Reviewing code is hard, if you keep the amount to review low we’ll review faster and there’s less chance we’ll make mistakes ↩
-
It bloats up the diff and makes it hard to be sure that nothing has regressed in the code movements.5 ↩
-
Merge commits are instructive when merging pull requests, but they are a hindrance during the pull request review period. ↩
-
Don’t get us wrong: We love refactors! Over time code gets warts and you might well be the beautician we need. If you want to refactor please submit the refactor as an entirely separate pull request! ↩