Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
93 lines (68 loc) · 2.23 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

93 lines (68 loc) · 2.23 KB

📝 Pull Request

Changes

Related Issues

Closes # Related to #

🧪 Test Coverage

BDD Scenarios

  • BDD scenarios written in Gherkin format
  • Scenarios implemented as automated tests
  • All BDD tests passing

TDD (Unit Tests)

  • Unit tests written before implementation (Red phase)
  • Implementation complete (Green phase)
  • Code refactored while keeping tests green (Refactor phase)
  • All unit tests passing

Test Evidence

# Test output here

✅ Definition of Done

Code Quality

  • Code follows project standards and style guide
  • No unnecessary complexity (YAGNI principle)
  • Code is self-documenting with clear naming
  • No duplicate code (DRY principle)

Testing

  • Test coverage maintained or improved
  • Edge cases covered
  • No test failures
  • Manual testing completed (if applicable)

Documentation

  • Code comments added where necessary
  • README updated (if needed)
  • API documentation updated (if applicable)
  • Migration guide added (if breaking changes)

Review

  • Self-review completed
  • PR is small and focused (< 400 lines preferred)
  • Commit messages are clear and descriptive
  • No merge conflicts

👁️ Reviewer Checklist

For Human Reviewers

  • Tests validate acceptance criteria
  • Code is simple and maintainable
  • Standards followed (no premature optimization)
  • Security considerations addressed
  • Performance impact acceptable

For Copilot Review

  • Request @github/copilot review for automated feedback
  • Address Copilot suggestions before human review

💡 Additional Context

🚀 Deployment Notes

  • Database migrations required
  • Environment variables added/changed
  • Feature flags configured
  • Breaking changes (document in CHANGELOG)

Kanban Workflow: This PR follows our Development Process Guide using Kanban + XP + Lean principles.