Skip to content

docs: redesign AGENTS.md with concise project guardrails - #64

Merged
pepakriz merged 1 commit into
mainfrom
codex/create-agents.md-with-best-practices
Apr 6, 2026
Merged

docs: redesign AGENTS.md with concise project guardrails#64
pepakriz merged 1 commit into
mainfrom
codex/create-agents.md-with-best-practices

Conversation

@pepakriz

@pepakriz pepakriz commented Apr 6, 2026

Copy link
Copy Markdown
Contributor

Motivation

  • Make the repository-level AGENTS guidance short, unambiguous and focused only on non-negotiable project rules.
  • Provide clear architecture guardrails for the local-first Evolu data model and shared UI contracts so automated agents avoid high-risk mistakes.
  • Move advanced workflows and lengthy playbooks into skills so AGENTS remains easy to scan and enforce.

Description

  • Rewrote AGENTS.md into a structured, project-scoped document with explicit sections for scope/priorities, architecture guardrails, Evolu write rules, error/result conventions, i18n/UI rules, safe change workflow, and a high-risk files list.
  • Preserved and clarified existing conventions for Evolu writes (evolu.update/upsert/insert), typed errors (defineError plus create...Error naming), and Result usage (ok/err).
  • Added directive that nested AGENTS.md files override at deeper directories and that direct user/developer/system instructions take precedence.
  • Stated that detailed step-by-step procedures belong in skills and kept AGENTS limited to essential, non-negotiable rules.

Testing

  • No automated tests were executed for this documentation-only change.

Codex Task

@pepakriz
pepakriz merged commit 62344a2 into main Apr 6, 2026
2 checks passed
@pepakriz
pepakriz deleted the codex/create-agents.md-with-best-practices branch April 6, 2026 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant