Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The DevSensei 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.

...

Ship Pull Requests

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 request. Examples include:

...

Adding a new feature

...

Changing how a feature work

...

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.

Examples:

  • Fixing a typo or spelling mistake

  • Increasing a dependency’s minor version

  • A bugfix you already discussed with the team or paired programmed on

Show Pull Requests

Choose Show pull request when you want to show what has been done, but otherwise you would like it to be merged automatically. You might still want to ask for review, but you essentially use it as validation and you don’t need to enter in a deep discussion.

...

  • Completing a well defined issue/ticket

  • a local refactoring you want people to be aware of (e.g., renaming a function or changing an small implementation detail)

  • added test cases

...

Ask Pull Requests

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.

Examples:

...

Fixing a typo or spelling mistake

...

Increasing a dependency’s minor version

...

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 request. Examples include:

  • Adding a new feature

  • Changing how a feature work

  • Major refactoring

You can read more about Ship/Show/Ask pattern in Martin Fowlers’s blog post.

...