Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 3.36 KB

pull_request_template.md

File metadata and controls

88 lines (70 loc) · 3.36 KB

📝 Summary

  • What changed (2-4 sentences):
  • Why (the problem it solves; link the issue / ADR / discussion):
  • AI assistance (which parts an AI drafted, if any; you still sign off for all of it):

🎯 Type

  • ✨ Feature
  • 🐞 Bug fix
  • ♻️ Refactor
  • ⚡️ Performance
  • 🔒 Security
  • 🧪 Tests only
  • 📚 Docs
  • ⚙️ Build / CI
  • 🧹 Chore / Maintenance
  • 💥 Breaking change

🔗 Linked issues

  • Closes #
  • Refs #

✅ Validation

  • Local gates green: this project's own lint, test, and build commands (the ones .github/workflows/checks.yml runs)
  • Tests (required for behavior changes; say what each new test pins down, and add a regression test for bug fixes):
  • Coverage: [ ] Unit · [ ] Integration · [ ] E2E · [ ] N/A
  • Manual steps a reviewer can follow to reproduce the result:
    1. [step]
    2. [step]
  • Evidence for UI or behavior changes (before -> after screenshots, recordings, or logs; redact secrets; add alt text on images):

💥 Risk & Rollback

  • Blast radius / breaking impact (migration steps if any):
  • Risk level: Low / Medium / High
  • Rollback plan (revert PR, disable flag, restore config):

🧭 Rollout (if applicable)

  • Feature flag (name + default):
  • Dependencies (linked PRs, migrations, config toggles):

📚 Docs & release notes

  • Docs updated (link) or N/A:
  • Release note (one user-facing sentence):

✅ Author checklist

  • One intent, sized for review (explain if the labeler tags it size: large or bigger)
  • Conventional Commit title, and commits signed off for DCO (git commit -s)
  • Local gates green (lint, test, build)
  • Tests added or updated for logic changes; documented above
  • No secrets committed; scanner alerts resolved
  • Docs updated when behavior or setup changed
  • Any AI-assisted work followed this project's agent instructions, if it has any
  • Targeting Development; ready to squash merge on green CI