Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.43 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

49 lines (31 loc) · 1.43 KB
Raw

module-name: One line description of your change (less than 72 characters)

Problem

Explain the context and why you're making that change. What is the problem you're trying to solve? In some cases there is not a problem and this can be thought of being the motivation for your change.

Solution

Describe the modifications you've done.

Result

What will change as a result of your pull request? Note that sometimes this section is unnecessary because it is self-explanatory based on the solution.

Some important notes regarding the summary line:

  • Describe what was done; not the result
  • Use the active voice
  • Use the present tense
  • Capitalize properly
  • Do not end in a period — this is a title/subject
  • Prefix the subject with its scope

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)