agents_template: Instructions file for Codex

Repository Contributor Guide

This template provides a baseline set of practices for repositories that use a .agents directory for contributor coordination. Update and extend these instructions to match your project's tooling, review process, and communication style before onboarding new contributors.

Where to Look for Guidance

• .feedback/: Planning notes, priorities, and stakeholder feedback. Treat these files as read-only unless you are explicitly asked to maintain them.
• .agents/:
  • Other subfolders (e.g., tasks/, brainstorms/, prompts/) capture active work, ideation, and reusable assets. Follow each folder's README or local AGENTS.md for details.
• .github/: Automation, workflow configuration, and repository-wide policy files.
• Additional directories may include their own AGENTS.md. Those files take precedence for the directory tree they reside in.

Development Basics

• Set up the project's runtime environment before modifying files. Prefer keeping setup instructions close to the code and/or in task notes; avoid long-lived documentation artifacts unless explicitly requested.
• Verification-first: confirm current behavior in the codebase before changing code; reproduce/confirm the issue (or missing behavior); verify the fix with clear checks.
• No broad fallbacks: do not add “fallback behavior everywhere”; only add a narrow fallback when the task explicitly requires it, and justify it.
• No backward compatibility shims by default: do not preserve old code paths “just in case”; only add compatibility layers when the task explicitly requires it.
• Minimal documentation, minimal logging: prefer reading code and docstrings; do not add docs/logs unless required to diagnose a specific issue or prevent a crash.
• Do not update README.md.
• Run linters, tests, and any required quality gates that apply to your contribution. Record exact commands in the task file so others can reproduce your results.
• Keep code, configuration, and documentation changes in sync. When you update behavior, review nearby docs for accuracy.
• Use structured commit messages such as [TYPE] Concise summary and keep pull request descriptions short and outcome focused.
• Break large efforts into reviewable commits or tasks. Reference related issues, design docs, or feedback files directly in your commits and PRs.
• Respect repository style guides. If none exist yet, update AGENTS.md and the relevant mode docs with short, direct rules.