Skip to content

Instantly share code, notes, and snippets.

@o6uoq
Last active January 30, 2026 21:54
Show Gist options
  • Select an option

  • Save o6uoq/e2bb5ad496624b39edde3da7b991757f to your computer and use it in GitHub Desktop.

Select an option

Save o6uoq/e2bb5ad496624b39edde3da7b991757f to your computer and use it in GitHub Desktop.
AGENTS.md

AGENTS.md

Philosophy

  • Correctness > speed
  • Small, reviewable changes
  • No production change without tests + conventional commits + focused PR
  • Kaizen: effective β†’ efficient; always improve, ask if unclear

Rules

  • Terse, explicit, minimal diffs, no speculative changes or unrelated refactors, no invented requirements
  • If unclear: follow this file and ask
  • Pre-commit required: pre-commit run -a (no bypass)

Git & PRs

  • main is protected: never write to it; if you're on main, stop and ask
  • Parallel: worktrees for concurrent agents (git worktree add ../<repo>-<branch> -b type/desc)
  • Cleanup: PR merged/closed β†’ delete branch + worktree; session end: git fetch --prune
  • Branch: type/short-desc (Conventional Branches; lowercase, hyphenated; intent must match commits)
  • Commit: <emoji> type(scope): summary (Conventional Commits)
  • Commits describe intent, not mechanics
  • Emoji map: πŸ— build | 🧹 chore | πŸ”„ ci | πŸ“š docs | πŸš€ feat | πŸ”§ fix | 🏎 perf | πŸ› οΈ refactor | 🎨 style | πŸ§ͺ test
  • PR: one logical change; body: ## Summary (1-5 bullets) β†’ contextual section (Test plan | Validation | Impact) β†’ πŸ€– footer

Task Management

  • Uses backlog CLI (brew install backlog-md)
  • Reference: backlog-guide.md
  • If backlog/ doesn't exist β†’ run /backlog-init

Testing

  • SDD (acceptance criteria, edge cases) β†’ BDD (Given/When/Then) β†’ TDD (RED β†’ GREEN β†’ REFACTOR; small increments)
  • Tests define correctness; code satisfies tests

Languages

Python

  • Deps + lock: uv (lockfile required)
  • Format + lint: ruff
  • Types: pyright (or mypy if already used)
  • Tests: pytest (add Hypothesis when invariants/edge cases matter)
  • Version: align with environment/container

DevOps + Platform

Flux / GitOps

  • Git is truth (committed YAML); flux reconcile over manual fixes; no hotfixes
  • If testing on cluster, backport to Git immediately
  • Never leave resources suspended

Extend via

  • docs/** for domain/ops/infra docs
  • CI/CD config files (enforcement beats docs)
  • Tool shims (e.g. CLAUDE.md) for deltas
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment