How to summarize a pull request for a reviewer
A pull request summary helps a reviewer understand the problem, approach and areas that deserve attention. It is most useful when the description reflects the actual supplied changes.
Start with the right material.
- What you provide
- an expanded text diff and issue context visible on the page.
- The intended result
- Save a summary of observed changes, motivation and tests actually shown in evidence.
How the workflow works.
Explain what changed and why, then identify behavior, compatibility or migration questions supported by the diff and notes. Keep tests performed separate from tests that are merely suggested.
What to check in the result.
Compare the summary with the changed files before posting. Do not claim a test passed or a risk was eliminated unless the supplied evidence establishes that result.
Preview the Markdown to check headings, lists and links as well as the words. Keep source references with the document so a reviewer can trace important statements back to the material you supplied.
Learn from the worked example.
The downloadable Markdown example shows one possible organization of the result. Read it alongside the source example and notice which statements are recorded facts, proposed wording or questions still needing an answer.
The supplied example is illustrative. It is not a recorded run on your data.
Download the example ↓Use it with your own material.
- Open the source you want to work with and activate WebAct on that tab.
- Copy the task from the hero, add any required fields or preferences, and review the proposed actions.
- Compare the first result with your source. Ask for a specific correction or refinement where needed.