Skip to content

chore(github): add pull request template with commit discipline checklist#1542

Open
Gkrumbach07 wants to merge 16 commits into
mainfrom
feature/rhoaieng-55733-pr-template
Open

chore(github): add pull request template with commit discipline checklist#1542
Gkrumbach07 wants to merge 16 commits into
mainfrom
feature/rhoaieng-55733-pr-template

Conversation

@Gkrumbach07
Copy link
Copy Markdown
Contributor

@Gkrumbach07 Gkrumbach07 commented May 11, 2026

Summary

Adds .github/PULL_REQUEST_TEMPLATE.md to the Ambient Code Platform repository. Currently there is no PR template, so contributors must manually remember all conventions from CLAUDE.md and the ACP Constitution. This template auto-populates on every new PR and prompts contributors to verify compliance before merge.

Implements RHOAIENG-55733 and fulfills the Follow-up TODO in .specify/memory/constitution.md line 56: "Update PR template to include commit discipline checklist".

Changes

  • Commit Discipline (Constitution Principle X): atomic commits, conventional format, line-count thresholds (bugfix ≤150, feat-small ≤300, feat-medium ≤500, refactor ≤400), 600-line PR cap with justification field
  • Quality: build gates for all component types (Go → go vet, frontend → npm run build, Python runner → pytest), no any types, no panic(), K8s OwnerReferences, GetK8sClientsForRequest() — all labeled with applicable component scope
  • Documentation: CLAUDE.md/AGENTS.md update reminder, API changes, breaking changes
  • Security: no committed secrets, container SecurityContext requirements

Related Issues

RHOAIENG-55733 | Constitution TODO: .specify/memory/constitution.md:56

Type of Change

chore — tooling/config, no source code changed

Component(s)

  • docs (.github/)

Test plan

  • Open a new PR on this repository and verify the template auto-populates
  • Confirm all five sections render correctly in the GitHub PR creation UI
  • Verify Jira acceptance criteria: template exists, covers all component types, references CLAUDE.md/constitution

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a structured pull request template to standardize and streamline the contribution workflow with sections for summaries, change descriptions, quality assurance, and security considerations.

…list

Implements the PR template called out in the ACP Constitution Follow-up
TODOs (line 56) and required by RHOAIENG-55733. Covers commit discipline
(Principle X), quality gates for all component types (Go, frontend,
Python), documentation, and security — so contributors verify compliance
without having to remember the rules from CLAUDE.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Gkrumbach07 Gkrumbach07 added the ambient-code:self-reviewed Self-reviewed by Ambient agent label May 11, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 11, 2026

Deploy Preview for cheerful-kitten-f556a0 canceled.

Name Link
🔨 Latest commit 6a20c89
🔍 Latest deploy log https://app.netlify.com/projects/cheerful-kitten-f556a0/deploys/6a038736d6c5020008a695b7

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 674a216a-6032-4244-8a47-3e96c739cd66

📥 Commits

Reviewing files that changed from the base of the PR and between e66be46 and 95fa0f1.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md

📝 Walkthrough

Walkthrough

Added a pull request template to .github/PULL_REQUEST_TEMPLATE.md providing a structured form with sections for change summary, related issues, type of change, affected components, commit discipline, quality readiness, documentation, and security checklists.

Changes

Cohort / File(s) Summary
GitHub Configuration
.github/PULL_REQUEST_TEMPLATE.md
New PR template with structured sections for summaries, issue linking, change classification, component selection, commit discipline validation, quality readiness (tests, linting, builds, Go vet, Python pytest), documentation, and security checklist items.
🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Title follows Conventional Commits format (chore(github): description) and accurately summarizes the PR's main change: adding a pull request template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Performance And Algorithmic Complexity ✅ Passed PR adds only a documentation template (.github/PULL_REQUEST_TEMPLATE.md, +64/-0 lines). No source code changes. Performance check is inapplicable to template files.
Security And Secret Handling ✅ Passed Documentation PR. No hardcoded secrets, tokens, or credentials. Template enforces security checklist: no secrets, SecurityContext, GetK8sClientsForRequest(), OwnerReferences.
Kubernetes Resource Safety ✅ Passed PR only modifies .github/PULL_REQUEST_TEMPLATE.md (a markdown template). No Kubernetes resources (manifests, deployments, RBAC configs) are changed. Check is not applicable.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/rhoaieng-55733-pr-template
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch feature/rhoaieng-55733-pr-template

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ambient-code:self-reviewed Self-reviewed by Ambient agent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant