Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.08 KB

PRTemplate.md

File metadata and controls

34 lines (25 loc) · 1.08 KB

Making a PR

Prior to submitting a pull request:

  • Ensure its focused on single problem.
  • Create notes for what code is doing.
  • Use intuitive naming conventions.
  • Commit description should be present tense & descriptive and relevant to what has changed.
  • Make/update test file for each file you changed. Can be pseudo code & updated later.
  • Remove any unused/deadcode. (commented out code)
  • 2 peers MUST review & submit written feedback to pull requests.

PR Title Format:

"[verb][what it does]"

PR Description:

Please make sure your description:

  • Outlines the motivation for the feature.
  • Links to user story & trello card in the description.
  • Includes screenshot and/or Loom of completed state of feature. (if applicable)

Reviewing a PR

  • Leave comments and suggestions!
  • Is code formatted properly?
  • Is commented out code deleted?
  • Are functions relatively small?
  • Are console logs removed?
  • Is there duplicate code?
  • Does code have TODO's commited to main? (please don't)
  • Go through "# Making a PR" checklist above to ensure all steps have completed before reviewing.