PULL_REQUEST_TEMPLATE.md

July 10, 2026 · View on GitHub

Summary

Why is this change needed?

What does this change do?

What does this fix or affect?

Type of change

  • feat - new capability
  • fix - bug fix
  • refactor - restructure without behavioural change
  • perf - measurable performance improvement
  • docs - documentation only
  • test - Pester / schema test changes
  • chore - dependency bump, version pin, file rename
  • ci - workflow / pipeline change
  • tune - analytical-rule threshold / severity / filter change

Files changed (high level)

Pre-merge checklist

  • Pester suite passes locally (./Tools/Invoke-PRValidation.ps1 -RepoPath .)
  • Bicep build passes locally if Bicep changed (az bicep build --file Infra/sentinel/main.bicep --stdout > /dev/null)
  • dependencies.json regenerated if KQL content changed (./Tools/Build-DependencyManifest.ps1 -Mode Generate)
  • Cross-platform parity maintained if pipelines/workflows changed (ADO + GitHub both updated)
  • Path-scoped instructions still match the touched content type's schema
  • No secrets in committed files (env vars, hardcoded tokens, connection strings)
  • Commit messages follow conventional-commit format (type(scope): subject + detailed body)
  • Documentation updated if the change affects user-visible behaviour

Testing

Required PR-validation status checks

  • template - PR description matches the template (this file)
  • validate - Pester suite under Tests/
  • bicep-build - az bicep build against Infra/**/*.bicep
  • arm-validate - Test-AzResourceGroupDeployment -WhatIf for playbooks (OIDC)
  • kql-validate - Microsoft.Azure.Kusto.Language parser across all queries
  • dependency-manifest - dependencies.json drift gate