Skip to content

docs(agents): replace Platform Context with public build-agent rules - #44

Open
yakimoto wants to merge 1 commit into
mainfrom
docs/agents-public-rules
Open

yakimoto wants to merge 1 commit into
mainfrom
docs/agents-public-rules

Conversation

@yakimoto

@yakimoto yakimoto commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

User description

What changed

This PR replaces the Platform Context section of AGENTS.md with a new Public Repository Rules for Build Agents section. The old section described internal build infrastructure and
references that only make sense inside the organization, which have no place in a public,
world-readable file. The new section
is a short, generic set of rules that any AI coding agent working in this repository should
follow when it writes anything that becomes public: pull request titles and bodies, commit
messages, code comments, issues, and documentation.

Why public repos need a scoped agent brief

AGENTS.md is the entry point an automated coding agent reads before it starts working in a
repository. In a public, open-source repository, everything an agent writes is permanent and
world-readable — including after an edit or a delete, since GitHub retains history. A brief
written for an internal, private codebase is the wrong brief for a public one: it can reference
things (internal tools, internal identifiers, internal process state) that make sense only to
people who already have private context, and that reveal more than intended once the file is
public. This change gives every public repository in this organization the same short, public-
safe brief, so an agent contributing here has clear, explicit guidance about the public/private
boundary before it opens its first pull request.

What an agent must not write in a public repo

The new section spells this out directly, but in short: no internal ticket, tracking, or
decision-record identifiers; no names of private repositories, internal hostnames, or internal
tooling; no description of approval status, pending decisions, or confidence scores; no internal
operational detail such as automation contracts, permission rules, or local working-directory
paths; no personal names tied to a process decision and no personal email addresses; no security
incident detail (vulnerabilities should be reported through the repository's normal security
process instead); and never a credential, key, or token — not even an example that looks
plausible. The guiding rule is simple: if something can't be described without an internal fact,
it isn't a public change, and the right move is to say so and route the work elsewhere rather
than write around it.

How to verify

  • The diff is scoped to AGENTS.md only, and only to the Platform Context section — every
    other section of the file (build/test instructions, contribution rules, the security policy
    pointer, and the machine-readable index at the bottom) is untouched.
  • git diff --stat on this branch shows a single file changed.
  • The new section reads the same way in every public repository that previously carried a
    Platform Context section, so it is easy to compare across repositories and confirm nothing
    repository-specific was dropped by mistake.
  • Continuous integration for this organization is temporarily unable to run automated checks on
    pull requests; this change was verified locally by rendering the resulting AGENTS.md and
    confirming the Markdown is well-formed and the surrounding sections are unchanged.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.


Note

Cursor Bugbot is generating a summary for commit d469300. Configure here.

Summary by Sourcery

Replace the internal platform context with public repository guidance for build agents.

Enhancements:

  • Replace internal platform guidance in AGENTS.md with concise, public-safe rules for build agents contributing to the repository.

Documentation:

  • Document boundaries for public contributions, including handling of internal identifiers, topology, operational details, personal information, security information, and secrets.

Review in cubic


CodeAnt-AI Description

Replace internal build-agent guidance with public-safe repository rules

What Changed

  • Removes internal platform, infrastructure, repository, and workflow references from AGENTS.md
  • Adds clear rules for writing public-facing titles, messages, comments, issues, and documentation
  • Instructs agents not to publish internal identifiers, private topology, approval details, operational information, personal data, security details, or secrets
  • Directs vulnerability reports to the repository’s private security process

Impact

✅ Safer public repository content
✅ Fewer internal details exposed
✅ Clearer guidance for build agents

💡 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.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown

ⓘ Qodo reviews are paused because your workspace is out of credits. Ask your workspace admin to add credits to resume reviews. Manage billing

@codeant-ai

codeant-ai Bot commented Sep 12, 2026

Copy link
Copy Markdown

🤖 CodeAnt AI — Review Status

Status Commit Started (UTC) Finished (UTC)
✅ Reviewed your PR d469300 Sep 12, 2026 · 17:27 17:28

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @yakimoto, this account has used its review budget of 2,500,000 diff characters for the last 7 days.

You can request another review in 22 hours and 50 minutes by commenting @sourcery-ai review.

@codeant-ai

codeant-ai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@cursor

cursor Bot commented Sep 12, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_92017f0d-9df3-45c2-af9a-cd7f01e3052e)

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 8d836658-6ff4-4c7e-a417-1e74d7be258b

📥 Commits

Reviewing files that changed from the base of the PR and between 720ca81 and d469300.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: 3 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (3)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: cubic · AI code reviewer
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
AGENTS.md (1)

33-81: LGTM!


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated repository guidance for build agents.
    • Added rules covering public visibility, internal information, approvals, operations, personnel, security details, and secrets.

Walkthrough

AGENTS.md now defines rules for public-repository content. It prohibits internal identifiers, operational details, personal information, security internals, and secrets. It removes the former platform-specific guidance.

Changes

Public repository guidance

Layer / File(s) Summary
Public content and information rules
AGENTS.md
Replaces platform-specific context with rules for externally understandable writing and restrictions on internal identifiers, topology, approvals, operations, people, security details, and secrets.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to d4693

This documentation-only change presents no merge-blocking runtime risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change: replacing the Platform Context section with public build-agent rules.
Description check ✅ Passed The description directly explains the AGENTS.md changes, their purpose, scope, and verification approach.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agents-public-rules
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/agents-public-rules

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

@sourcery-ai

sourcery-ai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Reviewer's Guide

The PR updates only the Platform Context portion of AGENTS.md, removing internal infrastructure references and replacing them with concise, repository-appropriate rules that define what build agents may safely write to public surfaces.

File-Level Changes

Change Details Files
Replaces organization-specific build-agent guidance with a public-safe policy for all agent-generated repository content.
  • Adds explicit rules requiring writing for external readers and excluding internal identifiers, topology, operations, approval status, and personal information.
  • Directs agents to use private security reporting for vulnerabilities and prohibits publishing security internals or plausible secrets.
  • Adds a stop-and-escalate rule for changes that cannot be described without internal context.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codeant-ai codeant-ai Bot added the size:M This PR changes 30-99 lines, ignoring generated files label Sep 12, 2026
@gitar-bot

gitar-bot Bot commented Sep 12, 2026

Copy link
Copy Markdown

Note

Automatic reviews are paused because your team has used its included automatic processing for this billing period (headroom scales with your seat count). You can still comment "Gitar review" to run one anytime, and automatic reviews resume on their own by October 1. Add seats for more headroom.
Learn more

Code Review 👍 Approved with suggestions 0 resolved / 1 findings

Replaces the internal Platform Context section of AGENTS.md with public-safe rules for build agents, establishing clear boundaries around what agents must not write in public repositories. Add a blank line before the ## CONTENTS heading at line 82 to match the formatting of other section boundaries in the file.

💡 Quality: Missing blank line before ## CONTENTS heading

📄 AGENTS.md:81-82

The new closing line 'When in doubt, treat it as internal...' runs directly into the ## CONTENTS heading with no blank line separating them, unlike every other section boundary in this file (e.g. lines 14, 20, 28, 32 all have a blank line before the next heading). Some Markdown renderers will not render the heading correctly without a preceding blank line. Add a blank line after line 81.

🤖 Prompt for agents
Code Review: Replaces the internal `Platform Context` section of `AGENTS.md` with public-safe rules for build agents, establishing clear boundaries around what agents must not write in public repositories. Add a blank line before the `## CONTENTS` heading at line 82 to match the formatting of other section boundaries in the file.

1. 💡 Quality: Missing blank line before `## CONTENTS` heading
   Files: AGENTS.md:81-82

   The new closing line 'When in doubt, treat it as internal...' runs directly into the `## CONTENTS` heading with no blank line separating them, unlike every other section boundary in this file (e.g. lines 14, 20, 28, 32 all have a blank line before the next heading). Some Markdown renderers will not render the heading correctly without a preceding blank line. Add a blank line after line 81.

Options

Display: compact → Counting what did not apply, without listing it.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

Comment thread AGENTS.md
Comment on lines +81 to 82
**When in doubt, treat it as internal.** Ask before publishing anything borderline.
## CONTENTS

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Quality: Missing blank line before ## CONTENTS heading

The new closing line 'When in doubt, treat it as internal...' runs directly into the ## CONTENTS heading with no blank line separating them, unlike every other section boundary in this file (e.g. lines 14, 20, 28, 32 all have a blank line before the next heading). Some Markdown renderers will not render the heading correctly without a preceding blank line. Add a blank line after line 81.

Was this helpful? React with 👍 / 👎

@macroscopeapp

macroscopeapp Bot commented Sep 12, 2026

Copy link
Copy Markdown

Approvability

Verdict: Would Approve

Macroscope's review found this PR approvable — The PR only replaces internal guidance in the root AGENTS.md with public-safe build-agent rules; it does not change application code, production configuration, APIs, or customer-facing runtime behavior. The change is isolated to the author's owned documentation file.

Not approved because:

  • Credit balance exhausted. Approvability relies on correctness review in order to determine eligibility

Review your spending limits in Billing settings. You can add or adjust custom eligibility rules. Learn more.

Comment thread AGENTS.md
Comment on lines +35 to +38
This repository is public. Anything written here — PR titles, PR bodies, commit messages,
comments, issues, and file content — is permanent and world-readable, including after edits
or deletes. Treat every write as if a competitor, reporter, or attacker is reading it, because
they can.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: The claim that edited or deleted PR text, comments, issues, and files remain world-readable is false and may cause agents to make incorrect disclosure decisions. [possible bug]

Assessment: 🟠 Major · 🔁 Occurrence: Often

Use CodeAnt Skill Fix in Cursor Fix in VSCode Claude

Prompt for AI Agent 🤖
This is a comment left during a code review.

**Path:** AGENTS.md
**Line:** 35:38
**Comment:**
	*Possible Bug: The claim that edited or deleted PR text, comments, issues, and files remain world-readable is false and may cause agents to make incorrect disclosure decisions.

Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix
👍 | 👎

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 issues found across 1 file

Confidence score: 3/5

  • In AGENTS.md, the claim that public text remains world-readable after edits or deletes is too absolute and could lead agents to make misleading privacy assurances; qualify it to cover possible persistence in edit history, notifications, forks, caches, or repository history.
  • In AGENTS.md, rules 2, 3, and 5 conflict with the unchanged GUIDELINES section, which names dpg.mjs, lattice-init, and Doppler; reconcile the guidance so agents receive one consistent policy on internal tools and secrets infrastructure.
Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="AGENTS.md">

<violation number="1" location="AGENTS.md:36">
P2: Do not state that all public text remains world-readable after edits or deletes. Qualify this as content that may persist through edit history, notifications, forks, caches, or repository history so agents do not rely on an inaccurate absolute claim.</violation>

<violation number="2" location="AGENTS.md:60">
P2: The new rules (2, 3, 5) ban naming internal tools and describing secrets infrastructure, but the unchanged GUIDELINES section in this same file still names dpg.mjs, lattice-init, and Doppler. Agents get directly conflicting instructions, and the file keeps publishing internal tooling names on a public surface, which is the exact outcome this PR is meant to remove. Replace the tool names with generic wording, e.g. "secrets are injected at build time and never stored in git," in the GUIDELINES bullet and drop the lattice-init attribution comments.</violation>
</file>
Architecture diagram
sequenceDiagram
    participant Agent as AI Coding Agent
    participant AGENTS as AGENTS.md
    participant GH as GitHub Public Repo
    participant Sec as Security Team
    participant Priv as Private Channels

    Note over Agent,Priv: NEW: Public-Facing Content Workflow with Safety Guards

    Agent->>AGENTS: Read public build-agent rules
    AGENTS-->>Agent: NEW: Public repo rules (write for strangers, no internal facts)
    
    Agent->>Agent: Draft content (PR title, body, commit, comment, doc)
    Agent->>Agent: NEW: Apply 9 safety rules check
    
    alt Content passes safety rules
        Agent->>GH: Publish public content
        GH-->>Agent: Content visible (world-readable, permanent)
    else Rule 9 triggered - internal fact required
        Agent->>Agent: NEW: Stop, do not launder fact
        Agent->>Priv: Route work to internal channel
    end
    
    opt Security vulnerability discovered
        Agent->>Sec: Report via SECURITY.md (security@wave.online)
        Sec-->>Agent: Confirmation (private)
        Note over Agent,Sec: NEW: Never public incident details
    end
    
    opt Writing file content
        Agent->>GH: Commit file changes
        GH->>GH: Retain history (permanent)
        Note over Agent,GH: NEW: Every write = permanent + world-readable
    end
Loading

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread AGENTS.md
confidence score, or that a change is waiting on someone's sign-off. Public PRs and issues
should stand on their own technical merits.

5. **No internal operations detail.** Never describe an internal automation contract, a

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The new rules (2, 3, 5) ban naming internal tools and describing secrets infrastructure, but the unchanged GUIDELINES section in this same file still names dpg.mjs, lattice-init, and Doppler. Agents get directly conflicting instructions, and the file keeps publishing internal tooling names on a public surface, which is the exact outcome this PR is meant to remove. Replace the tool names with generic wording, e.g. "secrets are injected at build time and never stored in git," in the GUIDELINES bullet and drop the lattice-init attribution comments.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At AGENTS.md, line 60:

<comment>The new rules (2, 3, 5) ban naming internal tools and describing secrets infrastructure, but the unchanged GUIDELINES section in this same file still names dpg.mjs, lattice-init, and Doppler. Agents get directly conflicting instructions, and the file keeps publishing internal tooling names on a public surface, which is the exact outcome this PR is meant to remove. Replace the tool names with generic wording, e.g. "secrets are injected at build time and never stored in git," in the GUIDELINES bullet and drop the lattice-init attribution comments.</comment>

<file context>
@@ -30,18 +30,55 @@ Apply the four grounding rules from [`wave-foundation/frameworks/platform-regist
+   confidence score, or that a change is waiting on someone's sign-off. Public PRs and issues
+   should stand on their own technical merits.
+
+5. **No internal operations detail.** Never describe an internal automation contract, a
+   permission rule, a secrets inventory, review-bot internals, an internal briefing document, a
+   local checkout or working-directory path, a session or lane identifier, or CI internals
</file context>

Comment thread AGENTS.md

You are working inside the WAVE platform (wave-av org, 157 repos). Before acting:
This repository is public. Anything written here — PR titles, PR bodies, commit messages,
comments, issues, and file content — is permanent and world-readable, including after edits

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Do not state that all public text remains world-readable after edits or deletes. Qualify this as content that may persist through edit history, notifications, forks, caches, or repository history so agents do not rely on an inaccurate absolute claim.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At AGENTS.md, line 36:

<comment>Do not state that all public text remains world-readable after edits or deletes. Qualify this as content that may persist through edit history, notifications, forks, caches, or repository history so agents do not rely on an inaccurate absolute claim.</comment>

<file context>
@@ -30,18 +30,55 @@ Apply the four grounding rules from [`wave-foundation/frameworks/platform-regist
 
-You are working inside the WAVE platform (wave-av org, 157 repos). Before acting:
+This repository is public. Anything written here — PR titles, PR bodies, commit messages,
+comments, issues, and file content — is permanent and world-readable, including after edits
+or deletes. Treat every write as if a competitor, reporter, or attacker is reading it, because
+they can.
</file context>

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

Labels

size:M This PR changes 30-99 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant