Skip to content
This repository has been archived by the owner on Oct 19, 2021. It is now read-only.

Latest commit

 

History

History
35 lines (24 loc) · 1.24 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

35 lines (24 loc) · 1.24 KB

Please complete this template, and please delete any sections you don't use.

Please set the PR title in this format: <type: feat/fix/chore/etc>(<scope>): [<issue-number>] <description>

example: refactor(PR-Template): [ABC-2343] update explanation for title format on PR template


Ticket Links

  • Ticket 1

What problem does this PR solve?

(Please summarize what's in the ticket or specification.)

How does this PR solve it?

(What is the approach? What tools are used?)

What Documentation/References will help understand the problem and solution?

(Please be sure to include links to any libraries, conversations, SO posts, etc.)

Screenshots or GIFs

(Taking a few seconds to provide images will likely save you explanation time in code-review... )

Any limitations or related work yet to be done?

(If someone else is working on a related story, please explain who and where...)

Any other things you've done here that aren't strictly related to the ticket?

(Consider putting big items in another PR. Small incidental ones are ok...)

How can reviewers test the changes?

  • (What user steps would someone need to follow to reach the feature and see it in action?)

To-Do List (if WIP):

  • Item 1
  • Item 2
  • Item 3