Skip to content

Add AGENTS.md for AI coding agents#423

Open
0x46616c6b wants to merge 1 commit intomainfrom
chore/add-agents-md
Open

Add AGENTS.md for AI coding agents#423
0x46616c6b wants to merge 1 commit intomainfrom
chore/add-agents-md

Conversation

@0x46616c6b
Copy link
Copy Markdown
Contributor

Type of Change

  • Documentation

Description

Adds an AGENTS.md file with compact, repo-specific guidance for AI coding agents (OpenCode, Copilot, Cursor, etc.) working in this repository.

The file covers the conventions most likely to be missed by an agent without prior context:

  • Action pinning -- full SHA with version comment, never tag refs
  • Template naming -- template_ prefix convention
  • Self-referencing -- @main for internal workflow calls
  • GitHub App auth pattern -- the USING_APP_CREDENTIALS dual-auth idiom
  • YAML style -- non-obvious .yamllint settings
  • Release automation -- don't manually edit README version refs

Checklist

  • Add relevant labels (for example type of change or patch/minor/major)
  • Make sure not to introduce some mistakes
  • Update documentation
  • Review the Contributing Guideline and sign CLA
  • Reference relevant issue(s) and close them after merging

The changes and the PR were generated by OpenCode.

Co-Authored-By: OpenCode <noreply@opencode.ai>
@0x46616c6b 0x46616c6b added documentation Pull requests with improvements or additions to documentation patch Pull request with little updates labels Apr 9, 2026
@0x46616c6b 0x46616c6b marked this pull request as ready for review April 9, 2026 07:54
@0x46616c6b 0x46616c6b requested a review from a team as a code owner April 9, 2026 07:54
@0x46616c6b 0x46616c6b requested review from axdotl and flaxel April 9, 2026 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests with improvements or additions to documentation patch Pull request with little updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant