Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
150 lines (111 loc) · 4.57 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

150 lines (111 loc) · 4.57 KB
Raw

Pull Request

Description

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🔧 Configuration change
  • ♻️ Code refactoring (no functional changes)
  • ⚡ Performance improvement
  • ✅ Test updates

Related Issues

Closes # Related to #

Changes Made

Testing

Test Environment

  • OS:
  • Browser (if applicable):
  • Version:

Test Cases

  • I have tested these changes locally
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Integration tests pass
  • Manual testing completed
  • Edge cases tested
  • I have performed a self-review of my own code

AI Review Checklist

The following AI review stages will be automatically executed:

  • 🟣 Stage 1: Gemini - Initial code analysis and architectural review
  • 🔵 Stage 2: Copilot - Code quality and best practices
  • 🔴 Stage 3: Codex - Security vulnerability analysis
  • 🟢 Stage 4: Final - Final confirmation and summary

Current Stage: Will be indicated by labels (ai-review/stage-*)

Review State: Tracked in state.json artifact (uploaded by AI agents)

Note: The AI review process is label-based and deterministic. Each stage will:

  1. Read the previous state.json artifact
  2. Perform its specific review
  3. Write findings to updated state.json
  4. Transition to the next stage via labels

If the PR is blocked due to issues requiring human intervention, the ai-review/blocked label will be added with details in the comments.

Screenshots (if applicable)

Security Considerations

  • No sensitive data exposed
  • Input validation implemented
  • Output sanitization applied
  • Authentication/Authorization checked
  • Dependencies reviewed for vulnerabilities
  • No hardcoded secrets or credentials

Performance Impact

  • No significant performance impact
  • Performance improved
  • Performance impact documented and acceptable

Documentation

  • Code comments added/updated
  • README updated
  • API documentation updated
  • Architecture diagrams updated (if applicable)
  • Migration guide provided (for breaking changes)

Deployment Notes

  • Database migrations required
  • Environment variables added/changed
  • Configuration updates needed
  • Dependencies added/updated
  • Breaking changes require coordination

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Additional Notes

For Reviewers

Human Review Checklist

After AI review is complete (ai-review/complete label):

  • Code changes reviewed and approved
  • Architecture/design validated
  • Test coverage adequate
  • Documentation sufficient
  • Security concerns addressed
  • Performance acceptable
  • Ready to merge

Merge Strategy

  • Squash and merge (recommended for feature branches)
  • Rebase and merge (for clean, atomic commits)
  • Create a merge commit (for important branches)

AI Review Status: Check labels for current stage State Artifact: Available in Actions artifacts after each stage Dashboard: See AI Review Dashboard for overall pipeline status