Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1.84 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

29 lines (23 loc) · 1.84 KB

Using this Pull Request Template

  • In the Description section below, please fill out the details of each of field.
  • In the Type of Change section, check the box for all that apply. To check the box in markdown format, simply replace the blank space between the [ ] with an x (i.e., [x])
  • In the Checklist Before Requesting a Review section, make sure you complete the required tasks that are pertinent to your task. Not all check boxes will need to be filled out for every type of task. Check the boxes as outlined previously (i.e., [x]).

Describe your changes

List the team you are on

Jira Feature/Task/Story and Link to it

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation addition/update (non-breaking change that adds documentation to the system)
  • This change requires a documentation update

Checklist before requesting a review

  • Do you want to keep your branch for future changes or delete it once it is reviewed?
  • I have followed the git practices outlined here to ensure code conflicts are minimized
  • My code follows the style guidelines of this project outlined here
  • I have performed a self-review of my code. It runs without errors and follows the Best Coding Practices
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • There are no API keys, passwords, usernames, or other secrets in the code. .env files are used for these secrets.
  • I have added tests that prove my fix is effective or that my feature works