|
| 1 | +# [AAP-XXXXX] Brief Title Describing the Change |
| 2 | + |
| 3 | +## Description |
| 4 | +<!-- Mandatory: Provide a clear, concise description of the changes and their purpose --> |
| 5 | +- What is being changed? |
| 6 | +- Why is this change needed? |
| 7 | +- How does this change address the issue? |
| 8 | + |
| 9 | +## Type of Change |
| 10 | +<!-- Mandatory: Check one or more boxes that apply --> |
| 11 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 12 | +- [ ] New feature (non-breaking change which adds functionality) |
| 13 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 14 | +- [ ] Documentation update |
| 15 | +- [ ] Test update |
| 16 | +- [ ] Refactoring (no functional changes) |
| 17 | +- [ ] Development environment change |
| 18 | +- [ ] Configuration change |
| 19 | + |
| 20 | +## Self-Review Checklist |
| 21 | +<!-- These items help ensure quality - they complement our automated CI checks --> |
| 22 | +- [ ] I have performed a self-review of my code |
| 23 | +- [ ] I have added relevant comments to complex code sections |
| 24 | +- [ ] I have updated documentation where needed |
| 25 | +- [ ] I have considered the security impact of these changes |
| 26 | +- [ ] I have considered performance implications |
| 27 | +- [ ] I have thought about error handling and edge cases |
| 28 | +- [ ] I have tested the changes in my local environment |
| 29 | + |
| 30 | +## Testing Instructions |
| 31 | +<!-- Optional for test-only changes. Mandatory for all other changes --> |
| 32 | +<!-- Must be detailed enough for reviewers to reproduce --> |
| 33 | +### Prerequisites |
| 34 | +<!-- List any specific setup required --> |
| 35 | + |
| 36 | +### Steps to Test |
| 37 | +1. |
| 38 | +2. |
| 39 | +3. |
| 40 | + |
| 41 | +### Expected Results |
| 42 | +<!-- Describe what should happen after following the steps --> |
| 43 | + |
| 44 | +## Additional Context |
| 45 | +<!-- Optional but helpful information --> |
| 46 | + |
| 47 | +### Required Actions |
| 48 | +<!-- Check if changes require work in other areas --> |
| 49 | +<!-- Remove section if no external actions needed --> |
| 50 | +- [ ] Requires documentation updates |
| 51 | + <!-- API docs, feature docs, deployment guides --> |
| 52 | +- [ ] Requires downstream repository changes |
| 53 | + <!-- Specify repos: django-ansible-base, eda-server, etc. --> |
| 54 | +- [ ] Requires infrastructure/deployment changes |
| 55 | + <!-- CI/CD, installer updates, new services --> |
| 56 | +- [ ] Requires coordination with other teams |
| 57 | + <!-- UI team, platform services, infrastructure --> |
| 58 | +- [ ] Blocked by PR/MR: #XXX |
| 59 | + <!-- Reference blocking PRs/MRs with brief context --> |
| 60 | + |
| 61 | +### Screenshots/Logs |
| 62 | +<!-- Add if relevant to demonstrate the changes --> |
0 commit comments