Skip to content

docs: add AGENTS.md for AI coding agents - #168

Merged
0x46616c6b merged 2 commits into
mainfrom
add-agents-md
Sep 30, 2026
Merged

0x46616c6b merged 2 commits into
mainfrom
add-agents-md

Conversation

@0x46616c6b

Copy link
Copy Markdown
Contributor

Type of Change

  • Bugfix
  • Enhancement / new feature
  • Refactoring
  • Documentation

Description

Goal: give AI coding agents the context they need to work in this repo without re-reading every script.

AGENTS.md covers:

  • lint/test commands, including how to run a single bats test
  • how action.yml steps and the scripts fit together (tag generation, retag on release, multi-arch, GitOps update per environment, multi-registry parsing)
  • script and test conventions
  • commit, PR and label conventions, including that the feature label bumps the major version

How to review: read AGENTS.md and check that it matches how the action works and how you want contributions to look.

Checklist

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Review the Contributing Guideline and sign CLA
  • Reference relevant issue(s) and close them after merging

🤖 Generated with Claude Code

…entions

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@0x46616c6b 0x46616c6b added the productivity Pull requests that improve how efficiently we build and ship label Sep 30, 2026
@0x46616c6b
0x46616c6b marked this pull request as ready for review September 30, 2026 11:15
@0x46616c6b
0x46616c6b requested review from a team as code owners September 30, 2026 11:15
@0x46616c6b
0x46616c6b requested review from flaxel, harikaduyu, ricoberger and soemo and a balanced review from Copilot September 30, 2026 11: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.

Copilot review overview

🟢 Approval recommended

The guide accurately reflects the repository; only a minor source-tag notation typo remains.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Adds repository guidance for AI coding agents, covering architecture, commands, conventions, and releases.

Changes:

  • Documents linting and test commands.
  • Summarizes action flow and contribution conventions.
  • Records release and labeling practices.
File Description
AGENTS.md Adds comprehensive coding-agent guidance.

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

Comment thread AGENTS.md Outdated
Updated `retag-image.sh` to handle image tags with `main`/`master` prefixes and clarified multi-arch handling in the build process.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@0x46616c6b
0x46616c6b merged commit 93dda5b into main Sep 30, 2026
10 checks passed
@0x46616c6b
0x46616c6b deleted the add-agents-md branch September 30, 2026 11:29
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 2026
@0x46616c6b 0x46616c6b added the chore Pull requests that are chores label Sep 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

chore Pull requests that are chores productivity Pull requests that improve how efficiently we build and ship

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants