Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.65 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

47 lines (31 loc) · 1.65 KB

Pull Request Template

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (reference issue number here, if any)

Type of change

Please delete options that are not relevant (including this line).

  • 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)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Operating System (Mac OS, Windows 10, etc.):
  • Text Editor (Atom, Eclipse, Vim, etc.):
  • Network (local, VPN, etc.):

Checklist:

Requirements Met:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the project documentation
  • My changes generate no new warnings or errors
  • I have checked my code and corrected any misspellings

Recommendations Met:

While these are not absolutely required for a contribution via pull request, we do encourage these items are completed.

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes