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
34 changes: 34 additions & 0 deletions .agent/scripts/commands/full-loop.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ The AI will iterate on the task until outputting:
- All requirements implemented
- Tests passing (if applicable)
- Code quality acceptable
- README.md updated (if adding features/APIs)
- Conventional commits used (for auto-changelog)

### Step 4: Automatic Phase Progression

Expand Down Expand Up @@ -134,9 +136,41 @@ Pass options after the prompt:
/full-loop "Refactor database layer" --no-auto-pr
```

## Documentation & Changelog

### README Updates

When implementing features or APIs, include README updates in your task:

```bash
/full-loop "Add user authentication with JWT tokens and update README"
```

The task development phase should update README.md with:
- New feature documentation
- Usage examples
- API endpoint descriptions
- Configuration options

### Changelog (Auto-Generated)

The release workflow auto-generates CHANGELOG.md from conventional commits. Use proper commit prefixes during task development:

| Prefix | Changelog Section | Example |
|--------|-------------------|---------|
| `feat:` | Added | `feat: add JWT authentication` |
| `fix:` | Fixed | `fix: resolve token expiration bug` |
| `docs:` | Changed | `docs: update API documentation` |
| `perf:` | Changed | `perf: optimize database queries` |
| `refactor:` | Changed | `refactor: simplify auth middleware` |
| `chore:` | (excluded) | `chore: update dependencies` |

See `workflows/changelog.md` for format details.

## Related

- `workflows/ralph-loop.md` - Ralph loop technique details
- `workflows/preflight.md` - Pre-commit quality checks
- `workflows/pr.md` - PR creation workflow
- `workflows/postflight.md` - Post-release verification
- `workflows/changelog.md` - Changelog format and validation
45 changes: 43 additions & 2 deletions .agent/workflows/ralph-loop.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,36 @@ Implement feature X following TDD:
7. Output: <promise>COMPLETE</promise>
```

### 4. Escape Hatches
### 4. Documentation Updates

Include documentation requirements in your completion criteria:

**README updates** - When adding features, APIs, or changing behavior:

```text
Implement feature X.

When complete:
- Feature working with tests
- README.md updated with usage examples
- Output: <promise>COMPLETE</promise>
```

**Changelog via commits** - Use conventional commit messages for auto-generated changelogs:

```text
# Good commit messages (auto-included in changelog)
feat: add user authentication
fix: resolve memory leak in connection pool
docs: update API documentation

# Excluded from changelog
chore: update dependencies
```
Comment on lines +245 to +255

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency and completeness, it would be better to use the same comprehensive Markdown table for conventional commit prefixes as used in .agent/scripts/commands/full-loop.md. The current list is missing perf and refactor prefixes.

Suggested change
**Changelog via commits** - Use conventional commit messages for auto-generated changelogs:
```text
# Good commit messages (auto-included in changelog)
feat: add user authentication
fix: resolve memory leak in connection pool
docs: update API documentation
# Excluded from changelog
chore: update dependencies
```
**Changelog via commits** - Use conventional commit messages for auto-generated changelogs:
| Prefix | Changelog Section | Example |
|--------|-------------------|---------|
| `feat:` | Added | `feat: add JWT authentication` |
| `fix:` | Fixed | `fix: resolve memory leak in connection pool` |
| `docs:` | Changed | `docs: update API documentation` |
| `perf:` | Changed | `perf: optimize database queries` |
| `refactor:` | Changed | `refactor: simplify auth middleware` |
| `chore:` | (excluded) | `chore: update dependencies` |


The release workflow auto-generates CHANGELOG.md from conventional commits. See `workflows/changelog.md`.

### 5. Escape Hatches

Always use `--max-iterations` as a safety net:

Expand Down Expand Up @@ -542,13 +571,25 @@ The loop is designed for maximum AI autonomy while preserving human control at s

| Phase | AI Autonomous | Human Required |
|-------|---------------|----------------|
| Task Development | Code changes, iterations, fixes | Initial task definition, scope decisions |
| Task Development | Code changes, iterations, fixes, README updates | Initial task definition, scope decisions |
| Preflight | Auto-fix, re-run checks | Override to skip (emergency only) |
| PR Creation | Auto-create with `--fill` | Custom title/description if needed |
| PR Review | Address feedback, push fixes | Approve/merge (if required by repo) |
| Postflight | Monitor, report issues | Rollback decision if issues found |
| Deploy | Run `setup.sh` | None (fully autonomous) |

### Documentation in Loops

**README updates**: Include in task development phase when adding features/APIs.

**Changelog**: Auto-generated from conventional commits during release. Use proper prefixes:
- `feat:` → Added section
- `fix:` → Fixed section
- `docs:` → Changed section
- `chore:` → Excluded from changelog
Comment on lines +586 to +589

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This list of commit prefixes is incomplete compared to the table in .agent/scripts/commands/full-loop.md. For consistency, please add the perf and refactor prefixes. You could group them to keep the list concise.

Suggested change
- `feat:` → Added section
- `fix:` → Fixed section
- `docs:` → Changed section
- `chore:` → Excluded from changelog
- `feat:` → Added section
- `fix:` → Fixed section
- `docs:`, `perf:`, `refactor:` → Changed section
- `chore:` → Excluded from changelog


See `workflows/changelog.md` for details.

### Options

```bash
Expand Down
Loading