Update docs and introduce AI Policy#1913
Conversation
Signed-off-by: Paulo Gomes <[email protected]>
Introduce an AI contribution policy aligned with Linux Foundation and CNCF guidance, and an AGENTS.md to orient AI tools working in the repository. Update CONTRIBUTING.md to reference the new policy and consolidate formatting/linting under golangci-lint. Signed-off-by: Paulo Gomes <[email protected]> Assisted-by: Claude Sonnet 4.6 <[email protected]>
There was a problem hiding this comment.
Pull request overview
Documentation-focused update to reflect v6 feature compatibility and to introduce repository guidance for AI-assisted contributions and automated agents.
Changes:
- Add
AI_POLICY.mdandAGENTS.mddescribing AI contribution expectations, disclosure, and repo working conventions. - Update
COMPATIBILITY.mdwith additional v6 capabilities/support statuses. - Update
CONTRIBUTING.mdto link to the AI policy and clarify lint/format expectations viagolangci-lint.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds an AI policy link and updates PR quality requirements wording. |
| COMPATIBILITY.md | Updates feature/support matrices to reflect additional v6 support. |
| AI_POLICY.md | Introduces AI contribution policy and disclosure requirements. |
| AGENTS.md | Adds guidance for AI agents/tools (layout, conventions, commit trailers, testing). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Paulo Gomes <[email protected]>
Add paths-ignore to test, git compatibility, cifuzz, and codeql workflows so they do not trigger when only markdown files or rfcs/ content is changed. Signed-off-by: Paulo Gomes <[email protected]> Assisted-By: Assisted-by: Claude Sonnet 4.6 <[email protected]>
| ``` | ||
| Assisted-by: GitHub Copilot | ||
| Assisted-by: Claude Sonnet 4.6 | ||
| Assisted-by: ChatGPT o3 |
There was a problem hiding this comment.
This might require clarification. As the example mix model and tools. In practice, I have really started to use AI for PRs since February and I rely on a subagent workflow with Claude code which means I have the main agent using opus while I have a coder, a reviewer and a commit contribution agent that use mostly sonnet but also haiku. Anyway, I think specifying tools is the logical and right things to do here.
There was a problem hiding this comment.
@cedric-appdirect good point. The example aims to highlight that you can specify multiple. However, I'd only refer to the agents that actively changed the given commit (or proposed changes to it). I'll add a comment to that effect.
This documentation update include:
COMPATIBILITY.mdto include features introduced inv6.AI_POLICY.mdandAGENTS.mdto define the project's AI Policy as well as clarify to agents how to work with the repository.CONTRIBUTING.mdto add a link to the AI policy.