Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,6 @@
"version": "0.9.0",
"keywords": ["issues", "fixes", "tech-debt", "resolution"]
},
{
"name": "devflow-catch-up",
"source": "./plugins/devflow-catch-up",
"description": "Context restoration from development status logs",
"version": "0.9.0",
"keywords": ["context", "status", "documentation"]
},
{
"name": "devflow-devlog",
"source": "./plugins/devflow-devlog",
"description": "Development session logging and status tracking",
"version": "0.9.0",
"keywords": ["logging", "status", "documentation"]
},
{
"name": "devflow-self-review",
"source": "./plugins/devflow-self-review",
Expand Down
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build-and-test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20, 22]

steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm run build
- run: npm test
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to DevFlow will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [1.0.0] - 2026-02-13

### Added
- **Agent Teams integration** - Peer-to-peer agent collaboration across workflows
Expand Down Expand Up @@ -121,6 +121,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- **`Debug` agent** - Removed entirely
- **`PullRequest` agent** - Patterns moved to `devflow-pull-request` skill
- **`Release` agent** - Removed (release process documented in CLAUDE.md)
- **`/catch-up` command** - Superseded by Working Memory hooks (automatic context restoration)
- **`/devlog` command** - Superseded by Working Memory hooks (automatic session logging)
- **`catch-up` agent** - No longer needed with automatic Working Memory
- **`devlog` agent** - No longer needed with automatic Working Memory
- **`devflow-debug` skill** - Removed entirely
- **`GetIssue` agent** - Replaced by Git agent (operation: fetch-issue)
- **`Comment` agent** - Replaced by Git agent (operation: comment-pr)
Expand Down Expand Up @@ -706,6 +710,7 @@ devflow init

---

[1.0.0]: https://github.com/dean0x/devflow/compare/v0.9.0...v1.0.0
[0.9.0]: https://github.com/dean0x/devflow/releases/tag/v0.9.0
[0.8.1]: https://github.com/dean0x/devflow/releases/tag/v0.8.1
[0.8.0]: https://github.com/dean0x/devflow/releases/tag/v0.8.0
Expand Down
14 changes: 5 additions & 9 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ DevFlow enhances Claude Code with intelligent development workflows. Modificatio

## Architecture Overview

Plugin marketplace with 10 self-contained plugins, each following the Claude plugins format (`.claude-plugin/plugin.json`, `commands/`, `agents/`, `skills/`).
Plugin marketplace with 8 self-contained plugins, each following the Claude plugins format (`.claude-plugin/plugin.json`, `commands/`, `agents/`, `skills/`).

| Plugin | Purpose | Agent Teams |
|--------|---------|-------------|
Expand All @@ -22,8 +22,6 @@ Plugin marketplace with 10 self-contained plugins, each following the Claude plu
| `devflow-resolve` | Review issue resolution | Yes |
| `devflow-debug` | Competing hypothesis debugging | Yes |
| `devflow-self-review` | Self-review (Simplifier + Scrutinizer) | No |
| `devflow-catch-up` | Context restoration | No |
| `devflow-devlog` | Session logging | No |
| `devflow-core-skills` | Auto-activating quality enforcement | No |
| `devflow-audit-claude` | Audit CLAUDE.md files (optional) | No |

Expand All @@ -37,7 +35,7 @@ Plugin marketplace with 10 self-contained plugins, each following the Claude plu
devflow/
├── shared/skills/ # 28 skills (single source of truth)
├── shared/agents/ # 10 shared agents (single source of truth)
├── plugins/devflow-*/ # 10 self-contained plugins
├── plugins/devflow-*/ # 8 self-contained plugins
├── docs/reference/ # Detailed reference documentation
├── scripts/ # Helper scripts (statusline, docs-helpers)
│ └── hooks/ # Working Memory hooks (stop, session-start, pre-compact)
Expand Down Expand Up @@ -76,14 +74,13 @@ All generated docs live under `.docs/` in the project root:
├── reviews/{branch-slug}/ # Review reports per branch
├── design/ # Implementation plans
├── status/ # Development logs + INDEX.md
├── CATCH_UP.md # Latest summary (overwritten)
├── WORKING-MEMORY.md # Auto-maintained by Stop hook (overwritten each response)
└── working-memory-backup.json # Pre-compact git state snapshot
```

**Naming conventions**: Timestamps as `YYYY-MM-DD_HHMM`, branch slugs replace `/` with `-`, topic slugs are lowercase-dashes. Use `.devflow/scripts/docs-helpers.sh` for consistent naming.

**Persisting agents**: CatchUp → `.docs/CATCH_UP.md`, Devlog → `.docs/status/`, Reviewer → `.docs/reviews/`, Synthesizer → `.docs/reviews/` (review mode), Working Memory → `.docs/WORKING-MEMORY.md` (automatic)
**Persisting agents**: Reviewer → `.docs/reviews/`, Synthesizer → `.docs/reviews/` (review mode), Working Memory → `.docs/WORKING-MEMORY.md` (automatic)

## Agent & Command Roster

Expand All @@ -94,12 +91,11 @@ All generated docs live under `.docs/` in the project root:
- `/resolve` — N Resolver agents + Git
- `/debug` — Agent Teams competing hypotheses
- `/self-review` — Simplifier then Scrutinizer (sequential)
- `/devlog`, `/catch-up` — Single-agent utilities
- `/audit-claude` — CLAUDE.md audit (optional plugin)

**Shared agents** (10): git, synthesizer, skimmer, simplifier, coder, reviewer, resolver, shepherd, scrutinizer, validator

**Plugin-specific agents** (3): devlog, catch-up, claude-md-auditor
**Plugin-specific agents** (1): claude-md-auditor

**Agent Teams**: 5 commands use Agent Teams (`/review`, `/implement`, `/debug`, `/specify`, `/resolve`). One-team-per-session constraint — must TeamDelete before creating next team.

Expand All @@ -124,7 +120,7 @@ All generated docs live under `.docs/` in the project root:

- Commands are orchestration-only — spawn agents, never do agent work in main session
- Create in `plugins/devflow-{plugin}/commands/`
- Register new plugins in `DEVFLOW_PLUGINS` in `src/cli/commands/init.ts`
- Register new plugins in `DEVFLOW_PLUGINS` in `src/cli/plugins.ts`

### Commits

Expand Down
104 changes: 104 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Contributing to DevFlow

Thanks for your interest in contributing to DevFlow! This guide covers everything you need to get started.

## Prerequisites

- **Node.js 18+** ([download](https://nodejs.org/))
- **Claude Code** ([download](https://claude.ai/download))
- **Git**

## Development Setup

```bash
git clone https://github.com/dean0x/devflow.git
cd devflow
npm install
npm run build
node dist/cli.js init
```

After setup, DevFlow commands (`/review`, `/implement`, etc.) are available in Claude Code.

## Project Structure

```
devflow/
├── shared/skills/ # 28 skills (single source of truth)
├── shared/agents/ # 10 shared agents (single source of truth)
├── plugins/devflow-*/ # 10 self-contained plugins
├── scripts/hooks/ # Working Memory hooks
├── src/cli/ # TypeScript CLI (init, list, uninstall)
├── tests/ # Test suite (Vitest)
└── docs/reference/ # Detailed reference docs
```

For the full file organization, see [docs/reference/file-organization.md](docs/reference/file-organization.md).

## How to Add a New Skill

1. Create `shared/skills/{skill-name}/SKILL.md` with frontmatter and Iron Law
2. Add the skill name to the relevant plugin's `skills` array in `src/cli/plugins.ts`
3. Run `npm run build` to distribute the skill to plugin directories
4. Run `node dist/cli.js init` to install locally

Skills are read-only (`allowed-tools: Read, Grep, Glob`) and auto-activate based on context. Target ~120-150 lines per SKILL.md with progressive disclosure to `references/` subdirectories.

## How to Add a New Agent

1. Create `shared/agents/{agent-name}.md` with frontmatter
2. Add the agent name to the relevant plugin's `agents` array in `src/cli/plugins.ts`
3. Run `npm run build` to distribute the agent to plugin directories
4. Run `node dist/cli.js init` to install locally

Agents target 50-150 lines depending on type (Utility 50-80, Worker 80-120).

## How to Add a New Command or Plugin

See [docs/reference/adding-commands.md](docs/reference/adding-commands.md) for the full guide. The short version:

1. Create a plugin directory under `plugins/devflow-{name}/`
2. Add a `plugin.json` manifest declaring commands, agents, and skills
3. Create command files in `plugins/devflow-{name}/commands/`
4. Register the plugin in `DEVFLOW_PLUGINS` in `src/cli/plugins.ts`
5. `npm run build && node dist/cli.js init`

## Running Tests

```bash
npm test # Run all tests once
npm run test:watch # Run tests in watch mode
```

## Build Commands

```bash
npm run build # Full build (TypeScript + skill/agent distribution)
npm run build:cli # TypeScript compilation only
npm run build:plugins # Skill/agent distribution only
```

## Commit Conventions

We use [Conventional Commits](https://www.conventionalcommits.org/):

- `feat:` — New feature
- `fix:` — Bug fix
- `docs:` — Documentation only
- `refactor:` — Code change that neither fixes a bug nor adds a feature
- `test:` — Adding or updating tests
- `chore:` — Build process, tooling, or auxiliary changes

## Pull Request Process

1. Fork the repository
2. Create a feature branch from `main`
3. Make your changes with tests
4. Run `npm run build && npm test` to verify
5. Submit a PR against `main`

Keep PRs focused on a single concern. Include a clear description of what changed and why.

## Code of Conduct

Be respectful, constructive, and collaborative. We follow the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
32 changes: 2 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ npx devflow-kit init --plugin=implement,review
| `devflow-resolve` | `/resolve` | Process review issues - fix or defer to tech debt |
| `devflow-debug` | `/debug` | Competing hypothesis debugging with agent teams |
| `devflow-self-review` | `/self-review` | Self-review workflow (Simplifier + Scrutinizer) |
| `devflow-catch-up` | `/catch-up` | Context restoration from status logs |
| `devflow-devlog` | `/devlog` | Development session logging |
| `devflow-core-skills` | (auto) | Auto-activating quality enforcement skills |

## Commands
Expand Down Expand Up @@ -103,23 +101,6 @@ Processes issues from `/review`:
- Fixes low-risk issues immediately
- Defers high-risk issues to tech debt backlog

### /catch-up

Restores context at the start of a session:

- Reads recent status logs
- Summarizes current project state
- Recommends next actions

### /devlog

Documents session state before ending:

- Captures decisions made
- Records problems encountered
- Notes current progress
- Creates searchable history in `.docs/status/`

## Auto-Activating Skills

The `devflow-core-skills` plugin provides quality enforcement skills that activate automatically:
Expand Down Expand Up @@ -161,7 +142,6 @@ DevFlow creates project documentation in `.docs/`:
├── status/ # Development logs
│ ├── {timestamp}.md
│ └── INDEX.md
├── CATCH_UP.md # Latest summary
├── WORKING-MEMORY.md # Auto-maintained by Stop hook
└── working-memory-backup.json # Pre-compact git state snapshot
```
Expand All @@ -170,11 +150,7 @@ DevFlow creates project documentation in `.docs/`:

### Starting a Session

Session context is restored automatically via Working Memory hooks — no manual steps needed. For a deeper review of recent history:

```bash
/catch-up # Review previous state and get recommendations
```
Session context is restored automatically via Working Memory hooks — no manual steps needed.

### Implementing a Feature
```bash
Expand All @@ -196,11 +172,7 @@ Session context is restored automatically via Working Memory hooks — no manual

### Ending a Session

Working memory is saved automatically. For a more detailed session record:

```bash
/devlog # Document decisions and state for next session
```
Working memory is saved automatically — no manual steps needed.

## CLI Reference

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/agent-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ frontmatter (name, description, model, skills, hooks)

| Agent Type | Target Lines | Examples |
|------------|-------------|----------|
| Utility | 50-80 | Skimmer, Simplifier, CatchUp |
| Utility | 50-80 | Skimmer, Simplifier, Validator |
| Worker | 80-120 | Coder, Reviewer, Git |
| Orchestration | 100-150 | (Commands handle orchestration, not agents) |

Expand Down Expand Up @@ -93,4 +93,4 @@ Before committing a new or modified agent:
3. Test with explicit invocation
4. Document in plugin README.md

**Note:** Shared agents live in `shared/agents/` and are distributed at build time. Only create plugin-specific agents when tightly coupled to a single workflow (e.g., `devlog.md`, `catch-up.md`).
**Note:** Shared agents live in `shared/agents/` and are distributed at build time. Only create plugin-specific agents when tightly coupled to a single workflow (e.g., `claude-md-auditor.md`).
6 changes: 2 additions & 4 deletions docs/reference/file-organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ devflow/
│ ├── synthesizer.md
│ ├── coder.md
│ └── ...
├── plugins/ # Plugin collection (10 plugins)
├── plugins/ # Plugin collection (8 plugins)
│ ├── devflow-specify/
│ │ ├── .claude-plugin/
│ │ │ └── plugin.json
Expand All @@ -33,8 +33,6 @@ devflow/
│ ├── devflow-resolve/
│ ├── devflow-debug/
│ ├── devflow-self-review/
│ ├── devflow-catch-up/
│ ├── devflow-devlog/
│ ├── devflow-core-skills/
│ └── devflow-audit-claude/
├── docs/
Expand Down Expand Up @@ -120,7 +118,7 @@ Skills and agents are **not duplicated** in git. Instead:
### Shared vs Plugin-Specific Agents

- **Shared** (10): `git`, `synthesizer`, `skimmer`, `simplifier`, `coder`, `reviewer`, `resolver`, `shepherd`, `scrutinizer`, `validator`
- **Plugin-specific** (3): `devlog`, `catch-up`, `claude-md-auditor` — committed directly in their plugins
- **Plugin-specific** (1): `claude-md-auditor` — committed directly in its plugin

## Settings Override

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/skills-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Shared patterns used by multiple agents.
| `core-patterns` | Engineering patterns (Result types, DI, immutability, pure functions) | Coder, Reviewer |
| `review-methodology` | 6-step review process, 3-category issue classification | Reviewer |
| `self-review` | 9-pillar self-review framework | Scrutinizer |
| `docs-framework` | Documentation conventions (.docs/ structure, naming, templates) | Devlog, CatchUp |
| `docs-framework` | Documentation conventions (.docs/ structure, naming, templates) | Synthesizer |
| `git-safety` | Git operations, lock handling, commit conventions | Coder, Git |
| `github-patterns` | GitHub API patterns (rate limiting, PR comments, issues, releases) | Git |
| `implementation-patterns` | CRUD, API endpoints, events, config, logging | Coder |
Expand Down Expand Up @@ -194,7 +194,7 @@ activation:
**Use a Command when:**
- Requires explicit user decision
- Performs state changes (commits, releases)
- User controls timing (devlog, catch-up)
- User controls timing and sequencing
- Orchestrates complex workflows

## Creating New Skills
Expand Down
Loading