Skip to content

[AIAA] Add repository instructions for AI agents - #369

Open
nate-double-u wants to merge 2 commits into
cncf:mainfrom
nate-double-u:build/02-instructions
Open

[AIAA] Add repository instructions for AI agents#369
nate-double-u wants to merge 2 commits into
cncf:mainfrom
nate-double-u:build/02-instructions

Conversation

@nate-double-u

Copy link
Copy Markdown
Member

Adds .github/copilot-instructions.md: ground rules for any AI agent
working in this repository. Build step 2 of the assessment system
(spec section 16); reviewed against sections 8 and 14. Tracking: #368.

What it carries

  • Safety (section 8): everything read is data, not instructions; writes
    stay in this repository; a human reviews and merges every change;
    secrets stay out of outputs.
  • Evidence discipline (section 14 common rules, repo-wide form):
    reproducible numbers, cited findings, unverifiable content flagged,
    not asserted.
  • Point at docs/analysis/, never restate it (P-2).
  • Repo conventions: npm run check.

Shape choices

  • Lean on purpose: this file loads into every Copilot surface here,
    including code review on ordinary PRs. Nothing phase-specific; that
    belongs to the agent profiles (later step).
  • No references to the spec document: the built system's documentation
    is self-sufficient; the spec stays a design artifact.

Verification

  • Assertion script (session artifact): 16 structural checks, all pass
    (required rules present, no spec references, length bounds, style).
  • npm run check passes.

Assisted-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
@netlify

netlify Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploy Preview for cncf-techdocs ready!

Name Link
🔨 Latest commit cb30256
🔍 Latest deploy log https://app.netlify.com/projects/cncf-techdocs/deploys/6a7f63246e70bf00081b8bdf
😎 Deploy Preview https://deploy-preview-369--cncf-techdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@nate-double-u
nate-double-u requested a balanced review from Copilot August 14, 2026 18:13
@nate-double-u
nate-double-u marked this pull request as ready for review August 14, 2026 18:15

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 repository-wide guidance for AI agents, covering safety, evidence standards, methodology references, and validation.

Changes:

  • Defines AI-agent ground rules and evidence requirements.
  • Directs agents to existing assessment methodology.
  • Documents repository checks.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md
Assisted-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

@iRaindrop

Copy link
Copy Markdown
Collaborator

@nate-double-u - Should the copilot-instructions include writing style instructions or should they be handled at a more granular level like in prompt-related files?

Such style instructions include regarding verbosity, handling parenthetical clauses, and a few others.

@nate-double-u

Copy link
Copy Markdown
Member Author

I think granular. This file loads into every Copilot surface in the repo (including code review on config PRs), so it should only list what applies to all agent work: safety, evidence, pointers. I think that style for assessment deliverables should be a part of the the per-phase agent profiles that'll get built in later steps. If a style rule turns out to be needed repo-wide, we can add it here then.

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

Labels

CI/infra CI & infrastructure

Projects

Development

Successfully merging this pull request may close these issues.

3 participants