Skip to content

docs: add AGENTS.md and pull-requests skill#245

Open
mtojek wants to merge 1 commit intomainfrom
ai-agents-docs-be09
Open

docs: add AGENTS.md and pull-requests skill#245
mtojek wants to merge 1 commit intomainfrom
ai-agents-docs-be09

Conversation

@mtojek
Copy link
Copy Markdown
Member

@mtojek mtojek commented Apr 1, 2026

Let this be the starting point for AI agents in this repo — a shared set of guidelines and skills to help them work effectively with the codebase. Just like README, these files need to be maintained as the project evolves.

Changes

  • AGENTS.md — main agent guidelines document with:

    • Tone & relationship rules (critical peer reviewer, no sycophancy)
    • Foundational rules (YAGNI, smallest changes, match style)
    • Essential commands table (make targets)
    • Architecture overview of AI Bridge as a gateway
    • Go patterns, streaming code guidelines, commit style
    • Common pitfalls table
  • .mux/skills/pull-requests/SKILL.md — PR workflow skill with:

    • Lifecycle rules (check existing PR, default to draft, never auto-merge)
    • PR title/description conventions
    • CI follow-up workflow (gh pr checks --watch, gh run view --log-failed)
    • Pre-push validation checklist
  • .gitignore — added AGENTS.local.md for local overrides

Context

Adapted from:

Skipped items not applicable to this repo: frontend, database, git hooks, swagger, OAuth2.

Add AI agent guidelines adapted from coder/coder best practices:
- AGENTS.md with architecture overview, Go patterns, streaming code
  guidelines, commit style, essential commands, and common pitfalls
- .mux/skills/pull-requests/SKILL.md with PR lifecycle rules, CI
  follow-up workflow, and pre-push validation checklist
- .gitignore entry for AGENTS.local.md (local overrides)
@mtojek mtojek marked this pull request as ready for review April 1, 2026 14:04
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