consolidate agent instructions into AGENTS.md, add AI policy#730
consolidate agent instructions into AGENTS.md, add AI policy#730
Conversation
wikkyk
added
documentation
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
2 times, most recently
from
cc0b07b to
54cbcd6
Compare
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
from
54cbcd6 to
91bea6c
Compare
wikkyk
changed the title
|
The contributing file could use a bit of polishing-up but that's a task for another time. |
There was a problem hiding this comment.
Pull request overview
This PR consolidates AI agent guidance into a new repository-level AGENTS.md (replacing .github/copilot-instructions.md) and adds an explicit policy section for AI-assisted contributions to CONTRIBUTING.md.
Changes:
- Adds an “AI-Assisted Contributions” policy section to
CONTRIBUTING.md. - Introduces
AGENTS.mdas the canonical AI agent instruction/reference document. - Removes
.github/copilot-instructions.mdin favor of the new consolidated document.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds contributor policy for AI-assisted work (authorship, transparency, oversight, quality bar). |
AGENTS.md |
New consolidated agent instructions and repo orientation (commands, architecture, CI, rules). |
.github/copilot-instructions.md |
Removed in favor of the consolidated AGENTS.md. |
| **Human oversight**: The human contributor is responsible for the entire contribution and must oversee it end to end — code, tests, and description. | ||
|
|
||
| **Quality**: A non-draft pull request must represent completed work: | ||
| - Includes relevant tests covering the changes |
There was a problem hiding this comment.
It already says 'relevant', 'where applicable' is redundant.
There was a problem hiding this comment.
Pull request overview
Consolidates AI coding agent guidance into a single repository-level document (AGENTS.md), removes the previous Copilot-specific instructions file, and adds explicit AI-assisted contribution policy to CONTRIBUTING.md.
Changes:
- Add an “AI-Assisted Contributions” policy section to
CONTRIBUTING.md(authorship, transparency, human oversight, quality bar). - Introduce
AGENTS.mdas the central “how to work in this repo” reference for AI agents and contributors. - Remove
.github/copilot-instructions.mdto avoid duplicated/competing instruction sources.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds AI-assisted contribution requirements alongside existing contribution/testing guidance. |
| AGENTS.md | New canonical agent instructions covering repo structure, commands, architecture, and CI expectations. |
| .github/copilot-instructions.md | Removes the previous GitHub Copilot instruction document in favor of the consolidated guidance. |
| hack/bump-go.sh <version> # Go version in go.mod, Dockerfile, docs | ||
| hack/bump-capi.sh <version> <stream> # cluster-api require, replace, metadata.yaml | ||
| hack/bump-k8s.sh <version> # k8s.io/* and ENVTEST_K8S_VERSION in Makefile | ||
| hack/bump-golangci-lint.sh <version> # golangci-lint in go.mod and .custom-gcl.yaml | ||
| ``` |
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
from
fce2626 to
229587f
Compare
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
from
229587f to
6830926
Compare
There was a problem hiding this comment.
Pull request overview
This PR consolidates AI agent contribution instructions into a single top-level AGENTS.md and adds an explicit AI-assisted contribution policy to CONTRIBUTING.md, while removing the prior GitHub Copilot-specific instructions file.
Changes:
- Added
AGENTS.mdas the canonical agent instructions document (repo structure, workflows, rules). - Added an “AI-Assisted Contributions” policy section to
CONTRIBUTING.md. - Removed
.github/copilot-instructions.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds AI-assisted contribution policy and PR hygiene guidance. |
| AGENTS.md | Introduces consolidated AI agent instructions and repo workflow reference. |
| .github/copilot-instructions.md | Deletes the previous Copilot-specific instructions document. |
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
from
6830926 to
a693686
Compare
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
from
a693686 to
fb9a20a
Compare
There was a problem hiding this comment.
Pull request overview
Consolidates AI coding agent guidance into a single repository-level document (AGENTS.md) and adds an explicit AI-assisted contribution policy to CONTRIBUTING.md, while removing the now-redundant GitHub Copilot-specific instructions file.
Changes:
- Add AI-Assisted Contributions policy to
CONTRIBUTING.md(authorship, transparency, oversight, quality). - Introduce
AGENTS.mdas the consolidated agent instructions / repo orientation document. - Remove
.github/copilot-instructions.mdto avoid duplicating instructions across files.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds AI-assisted contribution rules and PR hygiene guidance. |
| AGENTS.md | New canonical agent instructions and repo architecture/testing overview. |
| .github/copilot-instructions.md | Deletes superseded Copilot instructions content. |
| make test # Run unit tests | ||
| make test WHAT=./pkg/scope/... # Run tests for specific packages |
There was a problem hiding this comment.
Acceptable for now. This is going to get cleaned up: see #592
Replace CLAUDE.md and .github/copilot-instructions.md with a single AGENTS.md as the canonical source of truth for AI coding agent instructions. CLAUDE.md becomes a symlink to AGENTS.md; copilot- instructions.md is removed since copilot reads AGENTS.md natively. Co-Authored-By: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-Authored-By: Vic Kerr <wiktor.kerr@ionos.com>
Add AI-Assisted Contributions section to CONTRIBUTING.md covering authorship, transparency, human oversight, and quality expectations. Add general PR scope guidelines (complete, self-contained, reasonable size, dependent PRs). Reference CONTRIBUTING.md from AGENTS.md. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
wikkyk
force-pushed
the
docs/consolidate-agent-instructions
branch
from
fb9a20a to
638b90a
Compare
|
Description of changes:
Replaced .github/copilot-instructions.md with AGENTS.md as the canonical source of truth for all AI coding agent instructions. Added CLAUDE.md as a symlink to AGENTS.md (remove when claude starts reading AGENTS.md).
Added the AI policy that we have converged on into CONTRIBUTING.