feat: implement issue #1405 — [Phase 2] Add the "How to add an agentic role" runbook and a PR-template interaction-contract section

Merged
DO
3mo ago
+208-0

User description

Closes #1405

Implemented by dev-lead agent. Please review.

CodeAnt-AI Description

Add a runbook and required pull request guidance for agentic roles

What Changed

  • Added a step-by-step runbook for classifying agentic roles, defining interaction contracts, selecting event paths or approved bridges, and configuring safe timers.
  • Added a pull request template section requiring contributors to document triggers, emitted events, safeguards, budgets, and timer behavior when adding or changing an agentic role.
  • Linked the runbook from the agentic interaction standard so contributors can find the required process.
  • Documented which contract and timer checks are enforced by CI today and which workflow cross-checks are planned.

Impact

✅ Clearer agentic-role contribution requirements
✅ Fewer invalid workflow configurations
✅ Safer timer and self-trigger behavior

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

  • Documentation
    • Added a runbook explaining how to introduce agentic roles, including trigger classification, interaction contracts, event paths, timers, budget limits, and stop conditions.
    • Added a prominent link to the new runbook from the agentic interaction model documentation.
  • Chores
    • Added a pull request template with summary prompts, validation checks, documentation requirements, and an implementation checklist.