...
The app will help you apply the Ship/Show/Ask workflow to your pull requests, by guiding you through the decision to chose any of the three categories.
What is Ship
...
?
You will use Ship pull requests when you make small, barely noticeable changes that don’t require people to review, nor even to be aware of. Such small changes could in theory be pushed directly to the target branch, but for external reasons (e.g., internal policy, CI pipeline), you still want to keep it as a record pull request.
...
Fixing a typo or spelling mistake
Increasing a dependency’s minor version
A bugfix you already discussed with the team or paired programmed on
What is Show
...
?
Choose Show pull request when you want to show what has been done, but otherwise you would like it to be merged automatically. You still want people to be notified of the change (for example so that they can review later on) but you don’t expect the need for deep discussions.
...
Completing a well defined issue/ticket
a local refactoring you want people to be aware of (e.g., renaming a function or changing a small implementation detail)
added test cases
What is Ask
...
?
You will typically opt in for an Ask pull request when you want feedback and discussions on the changes you made. You only want to merge these changes after there was enough time for discussion, reviewing changes, and decide that it is fully ready. Ask pull requests correspond to the classical way of working with pull requests.
...
You can read more about Ship/Show/Ask pattern in Martin Fowlers’ blog post.
...
How does it work?
All pull requests are characterized by the app by 5 different categories. The behaviour of these categories is summarized in the table below.
...