pull-request-size-reminder

A command-line tool that queries git, reporting the size of your next pull request.


Why?

In a busy team you want to minimise the amount of time your colleagues spend reviewing your code. Small pull requests are usually the result of stories with a well-defined scope. Even with that, sometimes it gets away from us - especially if you are unfamiliar with the code. This package is intended to remind developers that the inevitable pull request may be large enough to annoy your colleagues.

It is intended to be used in a pre-commit and/or pre-push git hook, and is particularly useful in new projects or teams with less experienced developers.

Example output

!Great! Your branch has changed 4 files Good job! your pull request will be easy to review

!Careful! Your branch has changed 17 files Your pull request is getting a little bit on the large side, keep an eye on it

!Woah! A big PR! Your branch has changed 26 files Your pull request is large, think of your colleagues!

!Very large PR! Your branch has changed 45 files The number of files is too damn high!

Installation

``javascript
npm install --save-dev pull-request-size-reminder
`

Usage

You can call the package from the command-line, through node.

`bash
npx pull-request-size-reminder
`

The intended use is in conjunction with husky git hooks - precommit and/or prepush. Your project's package.json should be configured as below.

`javascript
{
"scripts": {
"precommit": "npx pull-request-size-reminder"
}
}
`

If you already have a precommit script then

`javascript
{
"scripts": {
"precommit": "someScript && node pull-request-size-reminder"
}
}
``

$3

The default configuration outputs the series of messages depending on how many files have been changed in your branch. See the Example output above

Configuration

None yet!