Skip to content

added an agents.md file#165

Merged
derekmisler merged 1 commit into
docker:mainfrom
derekmisler:added-an-agentsmd-file
May 6, 2026
Merged

added an agents.md file#165
derekmisler merged 1 commit into
docker:mainfrom
derekmisler:added-an-agentsmd-file

Conversation

@derekmisler
Copy link
Copy Markdown
Contributor

@derekmisler derekmisler commented May 4, 2026

Summary

Adds AGENTS.md, a comprehensive guide for AI agents and LLMs working in this repository. This document provides context on the repo's purpose, structure, critical conventions, and common tasks — enabling agents to understand the codebase and propose changes safely and correctly.

Changes

  • New AGENTS.md — 200+ lines covering:
    • What the repo is (GitHub Action for running Docker Agent)
    • Complete repo layout with annotations
    • Critical conventions (versioning, TypeScript rules, linting, testing, security-first design)
    • Workflow reference table
    • Common tasks cheat sheet
    • Editing checklist for contributors
    • Things to avoid (eval, env-var fallbacks, marker renames, etc.)
    • Links to related docs (README, security model, contributing rules)

Closes: https://github.com/docker/gordon/issues/487

@derekmisler derekmisler self-assigned this May 4, 2026
@derekmisler derekmisler requested a review from a team May 4, 2026 18:42
@derekmisler derekmisler marked this pull request as ready for review May 4, 2026 18:42
@docker-agent
Copy link
Copy Markdown
Contributor

docker-agent Bot commented May 4, 2026

⏭️ Review skipped — another review for this PR is already in progress (started 18s ago). Only one review runs at a time to avoid duplicate comments. The in-progress review will post its results when complete.

Copy link
Copy Markdown
Contributor

@docker-agent docker-agent Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟡 NEEDS ATTENTION

One factual inaccuracy found in the new AGENTS.md file. The feedback loop section misidentifies which component saves the pr-review-feedback artifact. See inline comment for details.

Comment thread AGENTS.md Outdated
derekmisler added a commit to derekmisler/cagent-action that referenced this pull request May 4, 2026
The pr-review-feedback artifact is uploaded by the reply-to-feedback

job in .github/workflows/review-pr.yml (via its Upload feedback

artifact step), not by the pr-review-reply.yaml agent file. Agent

YAMLs are consumed by the docker agent CLI and have no artifact

upload capability.

Addresses review feedback on PR docker#165.

Assisted-By: docker-agent
@derekmisler derekmisler enabled auto-merge (squash) May 4, 2026 20:13
@derekmisler derekmisler force-pushed the added-an-agentsmd-file branch 2 times, most recently from d18bc74 to c4ea61b Compare May 5, 2026 20:11
Signed-off-by: Derek Misler <derek.misler@docker.com>
@derekmisler derekmisler force-pushed the added-an-agentsmd-file branch from c4ea61b to 8ffb5bb Compare May 5, 2026 20:20
@derekmisler derekmisler requested review from a team and removed request for a team May 5, 2026 20:20
@derekmisler derekmisler merged commit 3bc964a into docker:main May 6, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants