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

Merged
YA
2mo ago
+46-9

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


[!NOTE]
Cursor Bugbot is generating a summary for commit de7ee0cfd9bb5b96b80c744775162f07e337bc79. Configure here.

Summary by Sourcery

Replace internal agent context with public repository rules that prevent sensitive organizational information from being published.

New Features:

  • Add public-safe guidance for build agents contributing to this repository.

Bug Fixes:

  • Remove internal platform and infrastructure details from the public agent instructions.

Enhancements:

  • Replace the internal Platform Context section with concise rules covering public communication, internal information, operational details, personal data, security information, and secrets.

Documentation:

  • Update AGENTS.md to establish a clear public/private boundary for repository content and contributions.

CodeAnt-AI Description

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

What Changed

  • Replaces private platform, infrastructure, and process references in AGENTS.md with guidance suitable for a public repository
  • Tells build agents to write for outside developers and avoid internal identifiers, private infrastructure details, approval status, operational information, personal data, security incidents, and secrets
  • Directs agents to stop and seek internal handling when work cannot be described without private information

Impact

โœ… Safer public pull requests and documentation
โœ… Fewer internal details exposed
โœ… Clearer guidance for automated contributors

๐Ÿ’ก 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.