Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,27 @@ Trigger manually: `gh workflow run pr-review.yml --repo petry-projects/.github-p

Mention trigger: Comment `@petry-review-bot` on any org PR for immediate review.

## Standards

Engineering standards live in `petry-projects/.github/standards/`.
Notable subtopics are listed below to aid discoverability; see the standards directory for full documentation.

| Standard | Notable subtopics |
|----------|-------------------|
| `advanced-security` | Code Security Configurations, push-protection live-fire (canary), custom secret scanning patterns, compliance audit checks |
| `agent-standards` | Required files, compliance exemptions, AgentShield CI workflow, decision-making reusables, BMAD Method Workflows |
| `ci-standards` | Staged promotion through concentric rings, reusable workflow versioning (`stable` channel), action pinning policy, permissions policy, Dev-Lead Agent |
| `codeowners-standard` | Team composition, required setup for new bots, branch protection, bypass actors |
| `copilot-instructions-standard` | Canonical instruction files, adding a new language, required sections, content quality rules |
| `dependabot-policy` | Configuration files, auto-merge workflow, vulnerability audit CI check, applying to a repository |
| `feature-ideation-sources` | AI/ML vendor & lab sources, developer tooling changelogs, security & compliance sources, newsletters, podcasts |
| `github-settings` | Org-level settings, repository rulesets, required checks ruleset, GitHub Apps & integrations, org-level secrets |
| `initiatives-project` | Project board fields, Theme → Initiative, how auto-add works, initiative classification |
| `persona-standards` | Canary onboarding (the last step), trigger matrix, trust & permissions, definition of done |
| `pr-limits` | Exempt actors, operator runbook, reconciliation with the Dependabot cap |
| `push-protection` | Layer 1 (GitHub push protection), Layer 2 (local pre-commit), Layer 3 (CI secret scanning), incident response |
| `ruleset-remediation-runbook` | Bypass actors, migrate checks into `code-quality`, delete legacy rulesets, rollback procedure |

## Documentation

- [Architecture & Capabilities](docs/pr-review-agent/pr-review-agent.md)
Expand Down
30 changes: 15 additions & 15 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ standards, and agentic infrastructure.
Engineering standards live in
[`petry-projects/.github/standards/`](https://github.com/petry-projects/.github/tree/main/standards).

| Standard | Purpose |
|---|---|
| `advanced-security` | GitHub Advanced Security configuration |
| `agent-standards` | Guidelines for building and deploying AI agents |
| `ci-standards` | CI/CD pipeline conventions |
| `codeowners-standard` | CODEOWNERS file requirements |
| `copilot-instructions-standard` | Copilot custom instruction guidelines |
| `dependabot-policy` | Dependency update and automerge policy |
| `feature-ideation-sources` | Sources and process for feature ideation |
| `github-settings` | Repository settings baselines |
| `initiatives-project` | Project board for tracking org initiatives |
| `persona-standards` | Agent and Copilot persona guidelines |
| `pr-limits` | Pull request size and scope limits |
| `push-protection` | Secret push protection configuration |
| `ruleset-remediation-runbook` | Steps to remediate ruleset violations |
| Standard | Purpose | Key sections |
|---|---|---|
| `advanced-security` | GitHub Advanced Security configuration | Enablement via Code Security Configurations · Push-protection live-fire test (canary) · Licensing & billing · Compliance audit checks |
| `agent-standards` | Guidelines for building and deploying AI agents | Required Files · Compliance Exemptions · AgentShield CI Workflow · Decision-Making Reusables · BMAD Method Workflows |
| `ci-standards` | CI/CD pipeline conventions | Staged promotion through concentric rings · Action Pinning Policy · Permissions Policy · Required Workflows · Dev-Lead Agent |
| `codeowners-standard` | CODEOWNERS file requirements | Team Composition · Required Setup for New Bots · Branch Protection |
| `copilot-instructions-standard` | Copilot custom instruction guidelines | Canonical Instruction Files · Required Sections · Content Quality Rules |
| `dependabot-policy` | Dependency update and automerge policy | Dependabot Templates · Auto-Merge Workflow · Vulnerability Audit CI Check · CODEOWNERS Approval Timing |
| `feature-ideation-sources` | Sources and process for feature ideation | AI / ML — Vendor & Lab Primary Sources · Developer Tooling & Platform Changelogs · Security & Compliance · Conferences |
| `github-settings` | Repository settings baselines | Repository Rulesets · Organization-Level Secrets · GitHub Apps & Integrations · Labels — Standard Set · Compliance Audit Process |
| `initiatives-project` | Project board for tracking org initiatives | What belongs on the board · Fields · Theme → Initiative · How the auto-add works |
| `persona-standards` | Agent and Copilot persona guidelines | The trigger matrix (onboarding checklist) · Canary onboarding · Trust, permissions, and safety · Definition of Done |
| `pr-limits` | Pull request size and scope limits | What is limited · Exempt actors · Reconciliation with the Dependabot cap · Operator runbook |
| `push-protection` | Secret push protection configuration | Layer 1 — GitHub Push Protection · Layer 2 — Local Pre-Commit Prevention · Layer 3 — CI Secret Scanning · Incident Response |
| `ruleset-remediation-runbook` | Steps to remediate ruleset violations | Bypass actors · Legacy rulesets — migrate checks first, then delete · Rollback |

## Custom Agents

Expand Down
Loading