pull_request_template.md

Overview 🚀

Include a summary of the change and which issues it addresses.

Type of change 🧙‍

• 🎉 Initial commit (area): a brief description of change.

• ✨ New feature (area): a brief description of change.

• 🐛 Bugfix (area): a brief description of change.

• 📚 Documentation (area): a brief description of change.

• 💡 Documenting source code (area): a brief description of change.

• 🐎 Performance (area): a brief description of change.

• 🚨 Tests (area): a brief description of change.

• 💚 Continuous Integration (area): a brief description of change.

• 🔒 Security (area): a brief description of change.

• 👕 Lint (area): a brief description of change.

• 🚀 Deploying stuff (area): a brief description of change.

• 🚧 Work in progress (area): a brief description of change.

• 🔧 Configuration files (area): a brief description of change.

• 💩 Bad code / need improv. (area): a brief description of change.

• 💥 Breaking changes (area): a brief description of change.

• 👌 Code review changes (area): a brief description of change.

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

Related Issue 🛠

Which issue(s) are related to this pull request?

• closes #example-issue

Checklist ✅

• 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 documentation

• My changes generate no new warnings

• I have added tests that prove my fix is effective or that my feature works

• New and existing unit tests pass locally with my changes

• Any dependent changes have been merged & published in downstream modules