mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-07-21 18:33:22 -07:00
jparkerweb
5e48e98293
- Add /plan2code-3b-review: 5-step post-implementation review with adaptive scope, 11 dimensions, reference-file architecture, and Plan/Apply/Verify fixes - Unify workflow/skill file naming to single-dash (drop -- and --- conventions) - Add Devin platform support and CLAUDE.md MANDATORY FIRST STEP template - Guide agents to use semantic anchors over line numbers in workflow prompts - Bump version to 1.14.0
57 lines
2.5 KiB
Markdown
57 lines
2.5 KiB
Markdown
# AGENTS.md
|
|
|
|
This file provides guidance to AI coding agents like Claude Code (claude.ai/code), Cursor AI, Codex, Gemini CLI, GitHub Copilot, Devin, and other AI coding assistants when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
Plan2Code is a structured 4-step workflow methodology for AI-assisted software development. It provides prompt templates that can be installed globally or per-project for various AI coding tools (Claude Code, Cursor, Copilot, Continue, Windsurf, Codeium, Devin).
|
|
|
|
**Version:** Check `version.json` for current version
|
|
**Author:** Justin Parker
|
|
**License:** MIT
|
|
|
|
## How to Use This File
|
|
|
|
This file is an index — each section below contains a brief summary and a link to a detail file in `.agents-docs/`. Read only the sections relevant to your current task. Full details (commands, tables, file lists) are in the linked files. The sections "Git Commit Messages" and "Project Overview" are fully inline here.
|
|
|
|
## Architecture
|
|
|
|
High-level directory structure, key files, workflow prompt inventory, and file naming conventions.
|
|
|
|
Details: [Architecture](./.agents-docs/AGENTS-architecture.md)
|
|
|
|
## Plan2Code Loop
|
|
|
|
Autonomous CLI tool (`plan2code-loop/`) that implements specs by looping through tasks. Covers loop architecture, modes (one-task vs one-phase), completion markers, and key source files.
|
|
|
|
Details: [Plan2Code Loop](./.agents-docs/AGENTS-plan2code-loop.md)
|
|
|
|
## Plan2Code Metrics
|
|
|
|
Recursive self-improvement toolchain (`plan2code-metrics/`) for collecting run metrics, aggregating by prompt generation, diagnosing weak steps, and proposing prompt edits.
|
|
|
|
Details: [Plan2Code Metrics](./.agents-docs/AGENTS-plan2code-metrics.md)
|
|
|
|
## Development Commands
|
|
|
|
Build commands, installer menu options, how the installer generates platform-specific files, platform format table, and how to edit workflow prompts.
|
|
|
|
Details: [Development Commands](./.agents-docs/AGENTS-development-commands.md)
|
|
|
|
## Code Style & Gotchas
|
|
|
|
Language/toolchain conventions for `install.js` vs TypeScript packages, and pitfalls to avoid (version sync, `.gitignore` pre-flight, character limits, User Feedback table format).
|
|
|
|
Details: [Code Style & Gotchas](./.agents-docs/AGENTS-code-style.md)
|
|
|
|
## Mascot
|
|
|
|
The project has a mascot called "Planny" - an ASCII art robot that appears in installer output and workflow prompts. Mascot variants are defined in `MASCOT` constant in `install.js` and appear in workflow markdown files.
|
|
|
|
```
|
|
╭───╮
|
|
│ ● │
|
|
│ ◡ │
|
|
╰───╯
|
|
```
|