Skip to content

Instantly share code, notes, and snippets.

@zhowzeng

zhowzeng/pr_template.md

Last active May 17, 2024 19:09
Show Gist options
  • Save zhowzeng/b50d331a2215e990b1ac5ce74fe14a89 to your computer and use it in GitHub Desktop.
Save zhowzeng/b50d331a2215e990b1ac5ce74fe14a89 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
pr_template.md

PR 1-liner Title

Tl;dr:

[optional] 1-liner if the context of the change is long

Context:

Few sentences on the high level context for the change. Link to relevant design docs or discussion.

This Change:

What this change does in the larger context. Specific details to highlight for review:

  • highlight1
  • highlight2
  • highlight3

Test Plan:

Go over how you plan to test it. Your test plan should be more thorough the riskier the change is. For major changes, I like to describe how I E2E tested it and will monitor the rollout.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment