Skip to content

Commit

Permalink
Add PR size guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
ffaf1 committed Feb 13, 2025
1 parent 595d023 commit e81b6e5
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e81b6e5

Please sign in to comment.