diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a7842017c5..361394fc818 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -360,6 +360,23 @@ If your PR is trivial you can omit this process (but explain in the PR why you think it does not warrant an issue). Feel free to open a new issue (or new issues) when appropriate. +### Pull request size + +Keep your pull requests small, write one pull request per feature, let +the content of the pull request match the title of the pull request. + +To get merged, your pull request needs to be reviewed by two other +contributors. Large pull requests are daunting to inspect, and the +back-and-forth between the author and reviewer can get frustrating and +difficult to follow. + +Split your pull requests in multiple ones if possible (e.g. a refactor +and a feature implementation should go in two different pull requests). +This is *especially* important for fixes which need to be backported: +they must be in their own pull request and not get mixed with other code. + +Thorough reviews mean less regressions, keeping your pull requests small +will improve Cabal codebase quality. ## Changelog