Skip to content

Commit 7602329

Browse files
authored
AAP-36315, docs: Add GitHub PR Template (ansible#673)
## Description This PR introduces a standardized PR template for our repositories to improve the quality and consistency of pull request submissions. The template was developed based on: - Analysis of our successful and problematic past PRs - Team's Definition of Done requirements - AWX project's PR template patterns - Current team needs identified in JIRA AAP-36315 ### Key Features: - Structured sections for description, testing instructions, and DoD checklist - Clear distinction between mandatory and optional information - Integration with our existing workflow (JIRA references, testing requirements) ## Testing Steps 1. Create a new PR in this repository 2. Verify that the template automatically loads 3. Test filling out both mandatory and optional sections 4. Confirm the template renders correctly in both GitHub and GitLab interfaces ## References - JIRA: [AAP-36315](https://issues.redhat.com/browse/AAP-36315) - Ongoing Template Discussion: https://redhat-internal.slack.com/archives/C0782UUSZ8X/p1733348812926029 - Mirrors aap-gateway/platform-service-template repo template: ansible-automation-platform/aap-gateway#650 ansible/platform-service-template#10
1 parent b0c42fd commit 7602329

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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

Comments
 (0)