Pull Request Template

pull_request_template.md

What?

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.

<KEYWORD> #ISSUE

Here's a list of valid \<KEYWORD\>

- Fixes/Fix/Fixed: Fixes an issue
- Closes/Close/Closed: Closes an issue
- Resolves/Resolve/Resolved: Resolves an issue
- Refer: Refers to issue

Type of change

Please delete options that are not relevant.

• 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)
• Other change (like general code up-keep and documentation)

How to run/reproduce?

MCV code for reproducability
- Minimal – Use as little code as possible that still produces the same problem/feature
- Complete – Provide all parts needed to reproduce the problem/feature
- Verifiable – Test the code you're about to provide to make sure it reproduces the problem/feature

How to revert?

MCV code for reverting
- Minimal – Use as little code as possible that still reverts the same problem/feature
- Complete – Provide all parts needed to revert the problem/feature
- Verifiable – Test the code you're about to provide to make sure it reverts the problem/feature

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. For example, if you coded in python -

• pytest
• hypothesis
• scalacheck

How to monitor post-merge?

MCV code to monitor and inspect changes
- Minimal – Use as little code as possible that can inspect and monitor changes post deployment
- Complete – Provide all parts needed to inspect and monitor changes post deployment
- Verifiable – Test the code you're about to provide to make sure it can inspect and monitor changes post deployment

Checklist

• My code follows the style guidelines
• 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 documentation
• My changes generate no new warnings
• I have added tests (if applicable) that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Commits largely follow a commit message style guide