Skip to content

docs: add AGENTS.md#112

Merged
emal-avala merged 2 commits intomainfrom
docs/agents-md
Apr 15, 2026
Merged

docs: add AGENTS.md#112
emal-avala merged 2 commits intomainfrom
docs/agents-md

Conversation

@emal-avala
Copy link
Copy Markdown
Member

Summary

  • Adds a top-level `AGENTS.md` so future contributors (human or AI) have a single place to learn the build, test, lint, security, and commit conventions of this repo
  • Documents the CI gate commands verbatim, the `PROTECTED_DIRS` invariant, the permission-check contract, and the "do not" list
  • References existing docs (`ARCHITECTURE.md`, `SECURITY.md`, `CONTRIBUTING.md`, `ROADMAP.md`, `RELEASING.md`) rather than duplicating them

Test plan

  • Render `AGENTS.md` on GitHub and visually check formatting
  • Confirm every command block matches `.github/workflows/ci.yml`
  • Confirm the `PROTECTED_DIRS` snippet matches `crates/lib/src/permissions/mod.rs`

Extends Phase 1, 4.3, 7.21 and appends §7.22-7.29 covering: compat
matrix, public SDK docs, reasoning-effort controls, phased desktop/web
client rollout, reversible edit history, multimodal TUI input, named
config profiles, enterprise TLS/proxy, SQLite session store, @-mention
file picker, turn-lifecycle hooks, and project rules.

Additive only; no existing entries were removed or reordered.
Codifies the non-obvious rules agents (human or AI) need before working
in this repo: the CI gate commands, protected-directory invariants, the
permission-check contract, coding conventions, commit/PR conventions,
release flow, and a concentrated "do not" list.
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@emal-avala emal-avala merged commit 6cd0049 into main Apr 15, 2026
13 of 14 checks passed
@emal-avala emal-avala deleted the docs/agents-md branch April 15, 2026 07:00
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