Skip to content

Commit 8e7a28f

Browse files
committed
Add PR size guidelines
1 parent 595d023 commit 8e7a28f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,23 @@ If your PR is trivial you can omit this process (but explain in the PR why you
360360
think it does not warrant an issue). Feel free to open a new issue (or new
361361
issues) when appropriate.
362362
363+
### Pull request size
364+
365+
Keep your pull requests small, write one pull request per feature, let
366+
the content of the pull request match the title of the pull request.
367+
368+
To get merged, your pull request needs to be reviewed by two other
369+
contributors. Large pull requests are daunting to inspect, and the
370+
back-and-forth between the author and reviewer can get frustrating and
371+
difficult to follow.
372+
373+
Split your pull requests in multiple ones if possible (e.g. a refactor
374+
and a feature implementation should go in two different pull requests).
375+
This is *especially* important when we decide to backport a pull request
376+
(be it fix or a feature).
377+
378+
Thorough reviews mean less regressions, keeping your pull requests small
379+
will improve Cabal codebase quality.
363380
364381
## Changelog
365382

0 commit comments

Comments
 (0)