Skip to content

Add AGENTS.md with AI security-audit guidelines#5397

Closed
pepone wants to merge 2 commits into
zeroc-ice:mainfrom
pepone:add-ai-audit-agents-md
Closed

Add AGENTS.md with AI security-audit guidelines#5397
pepone wants to merge 2 commits into
zeroc-ice:mainfrom
pepone:add-ai-audit-agents-md

Conversation

@pepone

@pepone pepone commented May 30, 2026

Copy link
Copy Markdown
Member

Adds AGENTS.md, with guidelines doc for AI coding agents (Codex, Claude Code, Copilot, etc.) running security audits of this repository. It documents:

  • the two-repo model (zeroc-ice/ice public, zeroc-ice/ice-audit private);
  • the mandatory two-independent-pass workflow (initial report + verification) and the verdict vocabulary;
  • issue routing by severity — security-sensitive Medium-and-above go private, everything else public;
  • issue conventions (labels, milestone, AI-generated banner, commit-pinned citations);
  • the catalogue of already-dismissed audit patterns so agents don't re-file findings closed as "Not planned".

Copilot AI review requested due to automatic review settings May 30, 2026 20:14

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new AGENTS.md document that standardizes how AI coding agents should conduct and route security audits for this repository, including a two-pass verification workflow, issue filing conventions, and a catalog of previously dismissed audit patterns to prevent duplicate/rejected findings.

Changes:

  • Introduces the two-repository model (zeroc-ice/ice public vs zeroc-ice/ice-audit private) and severity-based routing rules for findings.
  • Documents a mandatory two-independent-pass audit workflow with a defined verdict vocabulary and commit-pinned citation requirements.
  • Defines issue-filing conventions (titles/labels/milestones/body template) and lists dismissed audit patterns with canonical references.

Comment thread AGENTS.md
Comment on lines +89 to +90
gh issue list --repo zeroc-ice/ice-audit --label ai-audit --state all --search "is:closed reason:not-planned"
gh issue list --repo zeroc-ice/ice --label ai-audit --state all --search "is:closed reason:not-planned"
Comment thread AGENTS.md

## Dismissed audit patterns

The reasoning behind `ai-audit` findings closed as "Not planned" is captured here. Before opening a
@pepone pepone requested review from bernardnormier and externl June 1, 2026 07:51
@bernardnormier

Copy link
Copy Markdown
Member

Since an agent can only run such an audit when it has access to both repos (ice and ice-audit), should we put this AGENTS.md in the ice-audit repo?

@externl externl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If I understand how AGENTS.md is supposed to work. See also https://agents.md

  • I think this is too bloated. AGENTS.md is meant to be read by agentic agents per session. it should be relatively lean to limit token usage.
  • It's not just about security audits.

We should have something more like Homebrew's:

if we want something an agent reads when doing audit analytics I think belongs elsewhere.

Comment thread AGENTS.md
@@ -0,0 +1,209 @@
# Repository Guidelines for AI Coding Agents — Security Audits

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

AGENTS.md is not just about security audits. I would just go with the typical # AGENTS.md

See https://agents.md

Suggested change
# Repository Guidelines for AI Coding Agents — Security Audits
# AGENTS.md

Comment thread AGENTS.md
Comment on lines +3 to +5
These conventions apply to all AI coding assistants (Claude Code, Codex, Copilot, etc.) performing
**security audits** of this repository. They cover how an audit is run, how findings are verified,
where issues are filed, and which findings have already been considered and dismissed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is this necessary? Seems like wasted tokens/context.

@pepone

pepone commented Jun 2, 2026

Copy link
Copy Markdown
Member Author

I will move this to ai-audit, and keep as a security audit recipe instead of as the general agents file

@pepone pepone closed this Jun 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants