Skip to content

AGENTS.md

Latest commit

 

History

History
45 lines (27 loc) · 2.8 KB

AGENTS.md

File metadata and controls

45 lines (27 loc) · 2.8 KB
Raw

Agent Instructions

OKF knowledge set

This repository uses .okf/ as compact operational memory for AI agents.

OKF v0.1: non-reserved .md files need YAML frontmatter with non-empty type, title, and description; index.md is a directory listing; only bundle-root index.md may have frontmatter (okf_version).

Normative OKF use/update gates live in this file. .okf/index.md and .okf/maintenance.md are reminders and conformance detail; the okf-setup skill is setup/maintain procedure.

Before work

Match OKF depth to blast radius:

  • Local/small change: .okf/index.md + conventions/gotchas (and the matching task file if the surface is already documented).
  • Cross-cutting, public API, persistence, auth, contracts, or new surface: read the core set first (overview, architecture, code-map, conventions), then task-specific files (testing/workflows/dependencies/operations/gotchas and any expanded files present).

OKF guides, but it does not replace checking source, tests, or manifests for exact behavior.

During work

Preserve conventions, boundaries, and workflows from OKF. On conflict with source/tests/generated artifacts/manifests: prefer verified current behavior, update OKF, mention the correction.

Before finishing

Sync .okf/ when the change hits the update triggers in .okf/maintenance.md. Default trigger inventory: architecture/boundaries; public APIs/routes/schemas/events/contracts; persistence/migrations; deps/runtime; build/run/test/lint/format/generate/deploy; testing strategy; security/auth; config/env/ports/ops; conventions/layout; gotchas.

If no update needed, state why (pure comment/typo/formatting: OKF unaffected (non-behavioral edit)). Task is incomplete until OKF is synced or explicitly unaffected.

General

Subject to project conventions in OKF/conventions.md (and architecture when present) and this file:

  • Focused, minimal changes; prefer existing patterns.
  • Do not use em or en dashes as prose punctuation. Use commas, parentheses, or separate sentences instead. Hyphens remain valid in compound words, bullets, code, commands, CLI flags, identifiers, paths, versions, ranges, quotations, and exact terms.
  • Do not hand-edit generated artifacts listed in code-map/gotchas; regenerate via project commands instead. If a path is not listed but is clearly generated output, leave it alone and regenerate.
  • If behavior changes, run the smallest relevant command from workflows/testing. If not run, state the blocker.
  • Content lives in src/content/; docs/ is static build output only.
  • Develop and open PRs on dev only; never open PRs against main.

Branching

  • Do all development work and modifications on the dev branch. It has the latest changes that are not yet published on the live website.
  • Open all PRs against dev.
  • Never open PRs against main.