feat: add Pull Request template proposal

This commit introduces a standardized Pull Request template to help
contributors submit clear and consistent PRs.
The template includes sections for describing the change, testing
instructions, acceptance criteria, and related issues.

It aims to improve collaboration, streamline reviews, and reduce
misunderstandings by ensuring all relevant context is provided up front.
This commit is contained in:
davide
2025-04-15 21:12:51 +02:00
committed by davidescapolan01
parent fb358ad1a5
commit 1a053ca441

90
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,90 @@
<!-- Title of the PR:
Example: `fix: Update volume mount path in CKAD 001 Q6`
-->
---
#### 🧾 What this PR does
<!-- Briefly describe what this PR does.
Example: "This PR fixes the volume mount path in `sidecar-pod.yaml` to prevent conflicts with the nginx container's log directory."
-->
---
#### 🧩 Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Refactor
- [ ] Other (please describe): ____________
---
#### 🧪 How to test it
<!-- Provide clear, step-by-step instructions for testing this change.
Example: "Run the updated lab CKAD 001, Question 6. The pod should start correctly and nginx logs should be accessible."
-->
---
#### ✅ Acceptance Criteria
<!-- Tick each box once the corresponding criterion is met.
Feel free to add or remove items depending on what your PR changes.
-->
- [ ] Pod starts without errors
- [ ] Nginx logs are available
- [ ] All relevant tests pass
- [ ] Documentation is updated (if needed)
---
#### 📎 Related Issue(s)
<!-- Mention any related issues.
Example: "Closes #42" or "Refs #15"
-->
---
#### 💬 Notes for Reviewers
<!-- Add any extra context or notes for the reviewer.
Example: "I also tweaked the wording of the exercise to explicitly define container names."
-->
---
#### 📸 Screenshots / Logs (if applicable)
<!--
Include screenshots or log excerpts to help illustrate the problem or verify the fix.
-->
---
#### 🧠 Additional Context
<!--
Add any background or technical context that might help reviewers understand the motivation or constraints of the PR.
-->