Coding Guidelines

This repo is intended to be a guide primarily read by agents to understand preferences and guidelines for coding, research, or any other task.

This repo should be accessible for reference over the internet or placed into context accessible by agents for work on a project.

Guidelines are split into two trees:

• shared/: Portable guidelines that can be imported into projects and shared with others.
• personal/: Operator- and host-specific guidelines (shell config, host paths, personal skills). Stays in this repo; load when that context applies.

See the shared glossary for definition of specific terms and concepts as they are used throughout these documents.

Shared guideline groups

• Generic Agent Guidelines: Generic advice for any agent-assisted work.
• Project Management and Tooling: Config-file style, layered tooling, and how automation invokes tools.
• Software: Guidelines specific to the authorship and maintenance of software projects.
• Technical Writing: Guidelines for technical writing meant for a non-personal audience.
• Research: Guidelines for research.

Getting Started

• Projects: shared/getting-started.md (drop-in project AGENTS.md).
• Hosts (personal): personal/getting-started.md (drop-in ~/.agents/AGENTS.md, plus harness pointers such as ~/.config/goose/AGENTS.md for goose).

Maintaining this repo

See contributing/ for roles and workflows used to maintain this repository (not part of the portable shared set).