docs: harden and scope agent guidance - #583
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe pull request formalizes repository governance, adds directory-specific agent instructions, defines GitHub automation security rules, expands CODEOWNERS coverage, and documents validation requirements for documentation, GUI, scripts, and runtime source changes. ChangesRepository governance and ownership
Directory-specific instructions
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Review/merge ready. |
|
Added dual-landing guidance so agents follow the owner's interim policy:
Updated in |
|
Softened the dual-landing text after the owner's follow-up:
|
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
MAINTAINERS.md (1)
39-44: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winRecord this governance approval in the change log before merge.
Because this PR changes
AGENTS.md, add a dated entry underMAINTAINERS.md’s change log recording approval by@lidge-junor@Ingwannu. The current log only documents the prior@Wibiasmaintainer change and does not satisfy the PR’s stated completion requirement for this governance update.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@MAINTAINERS.md` around lines 39 - 44, Update MAINTAINERS.md’s change log with a dated entry documenting governance approval for the AGENTS.md change by either `@lidge-jun` or `@Ingwannu`, alongside the existing `@Wibias` entry, before merge.AGENTS.md (1)
49-61: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winResolve the contradictory
dev2-gotargeting rules.Lines 49-61 still make a
dev2-goPR invalid unless it touches Go/native-port files, but lines 72-77 say shared TypeScript changes may belong on both tracks and that the old Go-only rule is no longer sufficient. This can cause valid dual-track work to be rejected or retargeted incorrectly. Align lines 49-61 with the interim policy—for example, retaindevas the default while allowing maintainer-directed shared changes to target or land ondev2-go.Based on learnings, shared changes should land on both tracks when applicable without inventing dual-base PRs.
Also applies to: 63-77
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` around lines 49 - 61, Update the dev2-go targeting rules in AGENTS.md so dev remains the default branch while maintainer-directed shared changes may target or land on dev2-go when applicable. Remove the requirement that every dev2-go pull request touch Go/native-port scope and ensure the surrounding policy consistently states that shared changes should be applied to both tracks through separate pull requests, without requiring dual-base PRs.Source: Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@AGENTS.md`:
- Around line 49-61: Update the dev2-go targeting rules in AGENTS.md so dev
remains the default branch while maintainer-directed shared changes may target
or land on dev2-go when applicable. Remove the requirement that every dev2-go
pull request touch Go/native-port scope and ensure the surrounding policy
consistently states that shared changes should be applied to both tracks through
separate pull requests, without requiring dual-base PRs.
In `@MAINTAINERS.md`:
- Around line 39-44: Update MAINTAINERS.md’s change log with a dated entry
documenting governance approval for the AGENTS.md change by either `@lidge-jun` or
`@Ingwannu`, alongside the existing `@Wibias` entry, before merge.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: ec3b4e41-5bec-450f-9b6d-0092570e0812
📒 Files selected for processing (2)
AGENTS.mdMAINTAINERS.md
Branch-policy update (matches owner endgame)Replaced the earlier dual-track / Now documented in
Note for this PR: it still targets |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 54-58: Align the branch-policy exception across all authority
files: update AGENTS.md lines 54-58 to remove the exception or require
governance changes to be covered on dev2-go, apply the same requirement in the
review guidance at AGENTS.md lines 146-149, and keep the authoritative merge
policy consistent in MAINTAINERS.md lines 21-28.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 22d221a8-5dc2-4f91-86ad-dff83051440a
📒 Files selected for processing (2)
AGENTS.mdMAINTAINERS.md
CodeRabbit follow-upAddressed on latest push:
Not re-applied: the “Go-only This PR: under the updated rule it still needs to land on |
Intake policy updated (owner-confirmed)Rewrote branch policy to the locked day-to-day init:
Paused: freeze features on |
Keep owner Transition intake on root AGENTS/MAINTAINERS. Add nested agent guidance and require governance review for AGENTS.md paths.
81da91b to
41de832
Compare
Transition workflow completed
|
Summary
AGENTS.mdwith explicit source-of-truth, branch, workflow, validation, review, security, and completion rulessrc/,scripts/,docs-site/, and.github/gui/AGENTS.mdwhile preserving all existing i18n requirementsScope
This pull request changes repository governance and contributor guidance only.
It does not change runtime behaviour, dependencies, workflow permissions, release logic, publishing, or deployment behaviour.
Validation
gui/AGENTS.mdi18n requirements preservedgit diff --checkpasseddevworkflows were verified to acceptdev2-goas an integration targetRequired governance review
Changes to
AGENTS.mdand related agent-instruction files require explicit governance review underMAINTAINERS.md.Before merge:
@lidge-junor@IngwannuThis pull request should not be merged while that entry still describes the review requirement as incomplete.
Summary by CodeRabbit
Documentation
AGENTS.mdfiles, including workflow/security expectations, validation steps, and clear instructions for GUI, documentation site, source code, and release scripts.Governance / Policy
devanddev2-go, and clarified promotion/release timing guidance.AGENTS.mdupdates and updated ownership coverage for these policy documents.