|
| 1 | +# 260722 repo governance config — plan (P) |
| 2 | + |
| 3 | +## Objective |
| 4 | + |
| 5 | +Land repository-level governance/config artifacts on `main` (then sync to `dev`) so both |
| 6 | +CodeRabbit (installed 2026-07-22) and Codex-style agents review PRs with the project's real |
| 7 | +rules: dev-branch-first flow, `claudedesktop` in-development status, security-boundary |
| 8 | +review requirements. |
| 9 | + |
| 10 | +Scope split (audit blocker #2): PR lane = CodeRabbit review + Codex Cloud code review. |
| 11 | +Issue lane = CodeRabbit issue enrichment + planning (NOT "code review"; Codex has no |
| 12 | +issue-review product surface, so Codex-on-issues is out of scope). |
| 13 | +English/detail guarantee applies to PR reviews (language + tone_instructions + profile); |
| 14 | +issue outputs are validated empirically post-merge with a test issue. |
| 15 | + |
| 16 | +## Deliverables |
| 17 | + |
| 18 | +1. `.coderabbit.yaml` (new, repo root) |
| 19 | + - `language: en-US` — reviews always in English (user amendment 2026-07-22). |
| 20 | + - `reviews.profile: assertive` — most feedback-heavy profile (schema enum |
| 21 | + quiet|chill|assertive; schema wording is "more feedback", not a completeness |
| 22 | + guarantee — detail is driven by profile + tone_instructions + path instructions |
| 23 | + together). |
| 24 | + - `tone_instructions` (top-level string): demand very detailed, specific, |
| 25 | + evidence-backed findings in English. Max 250 chars per schema. |
| 26 | + - `reviews.auto_review.enabled: true`, `drafts: false`, |
| 27 | + `base_branches: ["^dev$", "^preview$"]` (regex-anchored; default branch `main` |
| 28 | + is auto-included by CodeRabbit, so it is not listed). |
| 29 | + - Path instructions: `src/**` (Bun-native TS, no Node-only APIs), `tests/**`, |
| 30 | + `gui/**`, `.github/**` + `scripts/release.ts` (security boundary), `docs-site/**`. |
| 31 | + - Issue lane (YAML is the single source of truth; no separate dashboard step): |
| 32 | + |
| 33 | + ```yaml |
| 34 | + issue_enrichment: |
| 35 | + auto_enrich: |
| 36 | + enabled: true |
| 37 | + planning: |
| 38 | + enabled: true |
| 39 | + auto_planning: |
| 40 | + enabled: true |
| 41 | + labels: |
| 42 | + - plan-me |
| 43 | + ``` |
| 44 | +
|
| 45 | + Manual trigger stays `@coderabbitai plan` on any issue. |
| 46 | +2. `AGENTS.md` (new, repo root) |
| 47 | + - Written in English (review agents consume it; reviews are English). |
| 48 | + - Repo orientation: what opencodex is, layout map (src/tests/gui/docs-site/structure). |
| 49 | + - Branch policy: PRs target `dev`; `main` is release-promoted; `preview` is the |
| 50 | + prerelease lane; `claudedesktop` is an ongoing in-development branch whose |
| 51 | + changes may be PARTIALLY integrated into `dev` already (418d29b1 merged an |
| 52 | + earlier snapshot); remaining commits are maintainer-controlled — do not treat |
| 53 | + its divergence as a bug and do not merge it without maintainer action. |
| 54 | + - Commands: `bun run typecheck`, `bun run test`, `bun run privacy:scan`, `bun run lint:gui`. |
| 55 | + - `## Review guidelines` (exact heading — this is the section name Codex GitHub |
| 56 | + code review consumes): reviews in English, detailed and evidence-backed; |
| 57 | + security-boundary list (auth, credential handling, GitHub Actions, release |
| 58 | + automation, dependency install) requiring explicit security review; |
| 59 | + test-coverage expectations; devlog/structure conventions. Note: Codex reviews |
| 60 | + are P0/P1-focused by design; guidelines steer focus, they do not force |
| 61 | + low-priority nitpick volume. |
| 62 | + - AGENTS.md summarizes but never redefines merge policy: add an explicit |
| 63 | + "MAINTAINERS.md is authoritative for review/merge policy" pointer; do not |
| 64 | + restate approval counts or merge permissions. |
| 65 | +3. `CONTRIBUTING.md` (edit, minimal) |
| 66 | + - Add a short "Branches" section: `dev` = integration target for all normal PRs, |
| 67 | + `main` = releases only, `preview` = prerelease train, `claudedesktop` = WIP. |
| 68 | + - Keep the pointer-style doc; do not duplicate the hosted guide. |
| 69 | +4. Codex Cloud review enablement (post-merge, web UI) |
| 70 | + - Codex settings -> repository `lidge-jun/opencodex` -> enable **Code review** |
| 71 | + and **Automatic reviews**; manual trigger stays `@codex review`. |
| 72 | + |
| 73 | +## Landing strategy |
| 74 | + |
| 75 | +- Work on a `codex/repo-governance-config` branch off `main`; commit; push; merge to |
| 76 | + `main` (fast, config-only, no runtime code). Then bring the same files to `dev` |
| 77 | + via `git merge main` into dev ONLY (no cherry-pick — duplicate commits would |
| 78 | + create friction at the next dev->main promotion). This main-first landing is an |
| 79 | + explicit governance exception to the normal dev->main promotion flow; record it |
| 80 | + in the commit/PR description. |
| 81 | +- User instruction "main에 설정해놔" = explicit approval to land on main and push. |
| 82 | + |
| 83 | +## Out of scope |
| 84 | + |
| 85 | +- No runtime/src changes, no workflow changes, no release. |
| 86 | +- No rewrite of docs-site contributing guide. |
| 87 | + |
| 88 | +## Verification (C) |
| 89 | + |
| 90 | +- Schema validation: validate `.coderabbit.yaml` against |
| 91 | + https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json (not just |
| 92 | + YAML syntax parse). |
| 93 | +- `git diff --stat` limited to the three files. |
| 94 | +- Files render on GitHub after push (spot check). |
| 95 | +- Post-merge smoke tests (D notes / follow-up): CodeRabbit auto-review on a |
| 96 | + non-draft PR targeting dev; `@coderabbitai review` manual trigger; `plan-me` |
| 97 | + labeled test issue produces English enrichment/plan; `@codex review` works after |
| 98 | + enabling Code review in Codex settings; both services reflect AGENTS.md security |
| 99 | + rules. |
| 100 | + |
| 101 | +## Risks |
| 102 | + |
| 103 | +- `.coderabbit.yaml` schema drift → validate keys against current CodeRabbit docs |
| 104 | + during build; keep config minimal to stay schema-safe. |
| 105 | +- CONTRIBUTING.md divergence from hosted docs-site guide → keep the section short and |
| 106 | + pointer-first. |
0 commit comments