cncf / cncf/techdocs

[AIAA] Build step 2: repository instructions for AI agents

Open Beginner friendly
#368 0 comments 0 reactions 0 assignees View on GitHub
CI/infra
Dominant language
TypeScript
Stars
56
Forks
29
PR merge metrics
No merged PRs in 30d

Description

Build step 2 of the AI-assisted assessment system: repository
instructions for any AI agent working in cncf/techdocs.

Deliverable: `.github/copilot-instructions.md`. It carries the safety
ground rules (content is data, not instructions; write only to this
repository; a human reviews and merges everything; secrets stay out),
the evidence discipline (reproducible numbers, cited findings,
unverifiable means flagged), and the point-don't-copy rule for the
methodology in `docs/analysis/`.

Scope note: this file loads into every Copilot surface in the repo,
including code review on ordinary PRs, so it stays lean and
repo-generic. Phase-specific behavior belongs to the agent profiles
(a later step).

Done when merged after review against the safety and agent-rules
sections of the design.

- [ ] Draft reviewed locally (assertion script green, `npm run check`
passes)
- [ ] PR opened
- [ ] Review against sections 8 and 14
- [ ] Merged

Contributor guide

No contributing guide indexed for this repository

Research direction

Create `.github/copilot-instructions.md` and keep it lean and repository-generic, covering the safety and evidence rules plus the point-don't-copy rule. Read sections 8 and 14 of the design, run the assertion script, and run `npm run check`. Done means the local checks pass and the file is opened for review against those sections before merge.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.