| # TeamADAPT Pull Request Template | |
| ## Governance Compliance Checklist | |
| ### Required Fields | |
| - [ ] **Linked DTO**: [Link to Data Transfer Object manifest] | |
| - [ ] **Linked ADR**: [Link to Architecture Decision Record if applicable] | |
| - [ ] **Risk Class**: [A/B/C] - *Select one and provide justification* | |
| - [ ] **Rollback Plan**: [Describe how to revert this change] | |
| - [ ] **Generated Artifacts**: [List any generated files included] | |
| - [ ] **Runbook Link**: [Link to updated or new runbook] | |
| - [ ] **SLO/Alert Updates**: [Describe monitoring changes] | |
| - [ ] **Explicit Pause Points**: [Identify where manual intervention required] | |
| ## Change Summary | |
| **Domain**: [signalcore/dataops/aiml/devops] | |
| **Type**: [feature/bugfix/refactor/docs/ops] | |
| **Impact**: [Describe what changes and who is affected] | |
| ### Description | |
| [Provide a clear description of the changes and the problem being solved] | |
| ### DTO Manifest Changes | |
| ```yaml | |
| # Paste relevant DTO changes here | |
| service: | |
| name: "example-service" | |
| ports: | |
| - port: 8080 | |
| # ... | |
| ``` | |
| ### Generated Artifacts | |
| - [ ] Systemd unit files | |
| - [ ] Supervisor configurations | |
| - [ ] Environment overlays | |
| - [ ] Monitoring configurations | |
| - [ ] Documentation updates | |
| ## Risk Assessment | |
| ### Risk Class: [A/B/C] | |
| **Justification**: [Explain why this change falls into the selected risk class] | |
| **Class A (High Risk)**: Cross-domain changes, production database modifications, security changes | |
| **Class B (Medium Risk)**: Domain-specific features, configuration changes | |
| **Class C (Low Risk)**: Documentation, minor bug fixes, non-critical improvements | |
| ### Impact Analysis | |
| - **Services Affected**: [List services that will be impacted] | |
| - **Dependencies**: [List cross-domain dependencies] | |
| - **Downtime Required**: [Yes/No] - [If yes, describe duration and window] | |
| - **Data Migration**: [Yes/No] - [If yes, describe process] | |
| ### Rollback Plan | |
| [Step-by-step instructions for reverting this change, including: | |
| - Configuration reverts | |
| - Database rollbacks if applicable | |
| - Service restart procedures | |
| - Verification steps] | |
| ## Testing & Validation | |
| ### Pre-Deployment Checks | |
| - [ ] DTO schema validation passed | |
| - [ ] Port collision scan completed | |
| - [ ] Generated artifacts are fresh | |
| - [ ] Runbook documentation updated | |
| - [ ] CI gates all passing | |
| ### Test Results | |
| - [ ] Unit tests passed | |
| - [ ] Integration tests passed | |
| - [ ] Performance benchmarks met | |
| - [ ] Security review completed | |
| - [ ] Operational validation done | |
| ### Monitoring Verification | |
| - [ ] SLO definitions updated | |
| - [ ] Alert rules configured | |
| - [ ] Dashboard changes implemented | |
| - [ ] Logging configuration validated | |
| ## Operational Readiness | |
| ### Runbook Updates | |
| - [ ] Incident response procedures | |
| - [ ] Recovery procedures | |
| - [ ] Performance troubleshooting | |
| - [ ] Security incident handling | |
| **Runbook Location**: [Link to specific runbook file] | |
| ### Deployment Instructions | |
| [Step-by-step deployment commands and verification steps] | |
| ```bash | |
| # Deployment commands | |
| ./deploy.sh --environment production --validate-security | |
| # Verification commands | |
| curl http://localhost:8080/health | |
| ./validate_deployment.py | |
| ``` | |
| ### Pause Points | |
| [Identify where deployment should pause for manual verification] | |
| 1. **Pre-deployment**: [Check description] | |
| 2. **Mid-deployment**: [Check description] | |
| 3. **Post-deployment**: [Check description] | |
| ## Documentation | |
| ### ADR Reference | |
| [If this change implements or relates to an ADR, provide context and link] | |
| ### API Changes | |
| [Describe any API changes, including breaking changes] | |
| ### Database Changes | |
| [Describe schema changes, migrations, or data transformations] | |
| ## Reviewers | |
| ### Required Reviewers | |
| Based on CODEOWNERS and change type: | |
| - [ ] @domain-owner (Domain expert) | |
| - [ ] @chase (Architecture review for cross-domain changes) | |
| - [ ] Additional reviewers as needed | |
| ### Review Focus Areas | |
| - [ ] DTO compliance and completeness | |
| - [ ] Risk assessment accuracy | |
| - [ ] Rollback plan feasibility | |
| - [ ] Operational readiness | |
| - [ ] Monitoring and alerting coverage | |
| ## Additional Context | |
| [Add any other context, screenshots, or references that will help reviewers] | |
| --- | |
| **By submitting this PR, I confirm:** | |
| - [ ] I have reviewed the CODEOWNERS file for this change | |
| - [ ] I have updated all required documentation | |
| - [ ] I have tested these changes thoroughly | |
| - [ ] I understand the risk classification and implications | |
| - [ ] I have a verified rollback plan | |
| - [ ] I have coordinated with dependent domain owners | |
| **PR Labels**: | |
| - [ ] dto-changed | |
| - [ ] generated-updated | |
| - [ ] runbook-updated | |
| - [ ] ops-ledger-updated | |
| - [ ] class-a / class-b / class-c | |
| - [ ] pause-needed (if applicable) |