Skip to content

docs: add AGENTS.md with repo guidance for AI coding agents - #45

Open
dcmcand wants to merge 1 commit into
mainfrom
docs/add-agents-md
Open

docs: add AGENTS.md with repo guidance for AI coding agents#45
dcmcand wants to merge 1 commit into
mainfrom
docs/add-agents-md

Conversation

@dcmcand

@dcmcand dcmcand commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Adds an AGENTS.md documenting how this meta-repository works, so contributors (and AI coding agents) can get productive without reverse-engineering the workflows.

What it covers

  • The two data flows: outbound community-health file sync (sync-issue-templates.yaml + .github/sync.yml) and the inbound reusable-workflow library (sync-project-priority, pack-build-image, pack-release).
  • pin_image_tags.py: what it does and why it fails loudly on missing paths.
  • Common commands: pre-commit, pytest for the scripts, and running actionlint locally the way CI does.
  • Conventions and gotchas: why prettier formatting is load-bearing for synced files, the intentionally scoped actionlint config, and the differing action-pin styles between older and newer workflows.

Also adds a .gitignore for local, per-developer agent config files.

Notes

  • AGENTS.md is not listed in .github/sync.yml, so it will not propagate to downstream repos.
  • Docs only; no workflow behavior changes.

Document the two roles of this meta-repository (outbound community-health
file sync and the inbound reusable-workflow library), the pin_image_tags
release helper, common dev commands, and repo conventions (prettier
formatting, scoped actionlint, action pin styles).

Also add a .gitignore for local, per-developer agent config files.
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.

1 participant