diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..320d9dff --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,63 @@ + + +# [Title] + +## πŸ“š Description of Changes + +_Provide an overview of your changes and why they’re needed. Link to any related issues (e.g., "Fixes #123"). If your PR fixes a bug, resolves a feature request, or updates documentation, please explain how._ + +- **What Changed:** + (Describe the modifications, additions, or removals.) + +- **Why This Change:** + (Explain the problem this PR addresses or the improvement it provides.) + +- **Affected Components:** + (Which component does this change affect? - put x for all components) +- [ ] Compose +- [ ] K8s +- [ ] Other (please specify) + +## ❓ Motivation and Context + +_Why is this change required? What problem does it solve?_ + +- **Context:** + (Provide background information or link to related discussions/issues.) + +- **Relevant Tasks/Issues:** + (e.g., Fixes: #GitHub Issue) + +## πŸ” Types of Changes + +_Indicate which type of changes your code introduces (check all that apply):_ + +- [ ] **BUGFIX:** Non-breaking fix for an issue. +- [ ] **NEW FEATURE:** Non-breaking addition of functionality. +- [ ] **BREAKING CHANGE:** Fix or feature that causes existing functionality to not work as expected. +- [ ] **ENHANCEMENT:** Improvement to existing functionality. +- [ ] **CHORE:** Changes that do not affect production (e.g., documentation, build tooling, CI). + +## πŸ”¬ QA / Verification Steps + +_Describe the steps a reviewer should take to verify your changes:_ + +1. (Step one: e.g., "Run `make test` to verify all tests pass.") +2. (Step two: e.g., "Deploy to a Kind cluster with `make create-kind && make deploy`.") +3. (Additional steps as needed.) + +## βœ… Global Checklist + +_Please check all boxes that apply:_ + +- [ ] I have read and followed the [CONTRIBUTING guidelines](.github/CONTRIBUTING.md). +- [ ] My code follows the code style of this project. +- [ ] I have updated the documentation as needed. +- [ ] I have added tests that cover my changes. +- [ ] All new and existing tests have passed locally. +- [ ] I have run this code in a local environment to verify functionality. +- [ ] I have considered the security implications of this change.