liveBook · Manning

Author's contract

As explained in "Looks Good to Me"

A set of responsibilities requiring a pull-request author to self-review, provide a manageable and understandable change, and respond constructively to feedback.

An author’s contract makes the pull-request author responsible for preparing a reviewable change and responding to feedback without treating it as a personal attack. section 2.4.2

Fulfill the contract by:

  • Acting as your own first reviewer: anticipate reviewers’ questions and answer them proactively. section 2.4.2
  • Making the pull request manageable: keep it short, atomic, and filled with context. section 2.4.2
  • Making the pull request understandable and checking that every required item is complete before review. section 2.4.2
  • Focusing on feedback and code improvement rather than on yourself or the reviewer. section 2.4.2
Figure 2.10 Guidelines for creating a feasibly-portioned PR (AKA how to make your PR manageable)
figure

Use the PR-portioning guidance to judge whether a change is small and manageable. section 2.4.2

Figure 2.11 A context-filled, properly completed, and ready-to-view PR
figure

Use the ready-to-view PR example to check context, completion, and review readiness. section 2.4.2

How "Looks Good to Me" covers it

How deep it goes
Defines four author responsibilities, from self-review and PR preparation to constructive responses, without specifying tools.
Examples
Uses guidance for feasibly portioned pull requests and a context-filled, completed, ready-to-view pull request.
What you can do after
Apply it via a pull-request workflow that produces smaller, contextualized, understandable changes and receives feedback constructively.
How it connects
Connects pull requests with code review, constructive feedback, reviewer questions, and codebase improvement.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of "Looks Good to Me". The section links point to the parts of the book it draws on.