Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Coding Agent Guidelines

A concise baseline for reliable coding work with Codex and Claude Code.

These rules constrain agent behavior without prescribing tools, workflows, or project architecture.

Why

Coding agents usually fail through poor judgment, not missing instructions.

A small set of constraints holds at every step: never fabricate or fake success, never act destructively without confirmation, ground user-facing decisions in user goals and product context, cover complete and accessible flows, and keep naming, architecture, and behavior consistent. A stated priority order settles conflicts between rules.

On top of that, five durable behaviors run in sequence:

  1. Understand the goal, and surface what the request gets wrong or leaves out.
  2. Understand the existing system before designing a solution.
  3. Design the smallest solution that carries no unrequested weight.
  4. Make surgical changes that preserve contracts.
  5. Verify outcomes with fresh evidence before claiming success.

Files

File Purpose
AGENTS.md Canonical guidelines for Codex and other compatible agents.
CLAUDE.md Claude Code entry point that imports AGENTS.md.
skills/coding-guidelines/SKILL.md Standalone skill package. Its body duplicates AGENTS.md so the skill can be distributed on its own.

Keep AGENTS.md authoritative. Keep CLAUDE.md as a compatibility shim.

Installation

Clone the repository:

mkdir -p ~/.config
git clone https://github.com/pyinx/coding-agent-guidelines.git ~/.config/coding-agent-guidelines

Project Scope

Copy both files into a new project root:

cp -n ~/.config/coding-agent-guidelines/AGENTS.md ./AGENTS.md
cp -n ~/.config/coding-agent-guidelines/CLAUDE.md ./CLAUDE.md

Commit the files so every contributor receives the same guidance.

Global Scope

Link the guidelines into both agent configuration directories:

mkdir -p ~/.codex ~/.claude
ln -s ~/.config/coding-agent-guidelines/AGENTS.md ~/.codex/AGENTS.md
ln -s ~/.config/coding-agent-guidelines/AGENTS.md ~/.claude/AGENTS.md
ln -s ~/.config/coding-agent-guidelines/CLAUDE.md ~/.claude/CLAUDE.md

The Claude link preserves the relative @AGENTS.md import.

If a target file exists, merge its content instead. Never overwrite existing instructions blindly.

Start a new agent session after changing instruction files.

Customization

Keep global rules universal. Put project commands and architecture boundaries in each repository.

Add a rule only when its absence causes a concrete, recurring failure.

Prefer principles over tool names. Prefer constraints over procedural checklists.

Remove rules that repeat platform defaults or cannot change a meaningful decision.

Contributing

Keep changes small and defensible.

Explain the failure mode addressed by every new rule.

Edit AGENTS.md first. Preserve CLAUDE.md as the import shim.

After changing AGENTS.md, mirror the body into skills/coding-guidelines/SKILL.md. The two must stay identical word for word.

License

No license has been declared yet.

About

Minimal, high-leverage engineering rules for Codex and Claude Code.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors