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
Copy link
Copy Markdown
Contributor

@ssncferreira ssncferreira left a comment

Choose a reason for hiding this comment

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

LGTM 👍 even though we're planning to move aibridge into coder shortly, so this will be short-lived, but could still be useful in the meantime. We'll need to reconcile with coder's AGENTS.md when that happens.

- Do not push to `origin/main` or `origin/master`.
- Do not skip local validation before pushing.
- Do not fabricate or embellish PR descriptions.
- Do not use `--no-verify` on git operations.
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.

I don't think this repo has any git hooks, so this will be a no-op. Nevertheless, good to have if that changes.

Use LSP tools (go to definition, find references, hover) **before** resorting to grep.
This codebase has 90+ Go files across multiple packages — LSP is faster and more accurate.

## Architecture Overview
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.

This section is already covered in the repo readme: https://github.com/coder/aibridge/blob/main/README.md#architecture
In order to avoid maintenance problems (updating both sections to reflect new changes), it might be better to reference the readme file for the full architecture diagram and request flow.

# Project specific
example/aibridge.db

AGENTS.local.md
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.

nit: newline missing

@mtojek
Copy link
Copy Markdown
Member Author

mtojek commented Apr 13, 2026

Firstly, I do appreciate the review @ssncferreira! I'm catching up with the progress and considering the ongoing draft from @pawbana, it may be a little late to introduce this PR.

Unless somebody thinks differently, I'm down to closing the PR.

@pawbana
Copy link
Copy Markdown
Contributor

pawbana commented Apr 13, 2026

Firstly, I do appreciate the review @ssncferreira! I'm catching up with the progress and considering the ongoing draft from @pawbana, it may be a little late to introduce this PR.

Unless somebody thinks differently, I'm down to closing the PR.

I don't think code move would change usefulness of this PR? I think there can be multiple such files in single repo?

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.

3 participants