56e3f83955
- Add auth.RequireScope() to all handler routes for proper authorization - Add SDLC OpenAPI endpoint documentation (state, features, tasks, branches, merge, archive, orchestrator) - Add SDLC documentation guides (getting-started, cli-reference, api-reference, command-catalog) - Add artifact_test.go for SDLC artifact coverage - Add CLAUDE.md rules: auth scopes requirement, error wrapping with %w - Fix error wrapping to use %w instead of %v throughout codebase - Improve CLI merge command with conflict detection and resolution - Fix handler tests to include auth middleware for RequireScope - Add cookbook tree runner scripts for automated testing Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
89 lines
2.2 KiB
Markdown
89 lines
2.2 KiB
Markdown
# SDLC Orchestration - Getting Started
|
|
|
|
This guide helps you set up and use the SDLC (Software Development Lifecycle) orchestration system in your project.
|
|
|
|
## Overview
|
|
|
|
The SDLC system provides deterministic feature lifecycle management through:
|
|
|
|
- **State tracking**: Features progress through defined phases
|
|
- **Artifacts**: Required deliverables at each phase (specs, designs, reviews)
|
|
- **Classifier**: Recommends the next action based on feature state
|
|
- **Branch management**: Tracks feature branches with merge readiness checks
|
|
- **Task tracking**: Break down features into implementable tasks
|
|
|
|
## Quick Start
|
|
|
|
### 1. Initialize SDLC in Your Project
|
|
|
|
From your project root:
|
|
|
|
```bash
|
|
sdlc init --project "My Project"
|
|
```
|
|
|
|
This creates the `.sdlc/` directory structure:
|
|
|
|
```
|
|
.sdlc/
|
|
├── config.yaml # Project configuration
|
|
├── state.yaml # Global state
|
|
├── features/ # Feature directories
|
|
└── branches/ # Branch manifests
|
|
```
|
|
|
|
### 2. Create Your First Feature
|
|
|
|
```bash
|
|
sdlc feature create my-feature --title "My First Feature"
|
|
```
|
|
|
|
This creates a feature in the `draft` phase.
|
|
|
|
### 3. Check What to Do Next
|
|
|
|
```bash
|
|
sdlc next --feature my-feature
|
|
```
|
|
|
|
The classifier returns the recommended action (e.g., `CREATE_SPEC`).
|
|
|
|
### 4. Progress Through Phases
|
|
|
|
Features move through 10 phases:
|
|
|
|
1. **draft** - Initial feature creation
|
|
2. **specified** - Requirements documented and approved
|
|
3. **planned** - Design and task breakdown complete
|
|
4. **ready** - Ready for implementation
|
|
5. **implementation** - Active coding
|
|
6. **review** - Code review
|
|
7. **audit** - Security audit
|
|
8. **qa** - Quality assurance testing
|
|
9. **merge** - Ready to merge
|
|
10. **released** - Merged and complete
|
|
|
|
## Configuration
|
|
|
|
Edit `.sdlc/config.yaml` to customize:
|
|
|
|
```yaml
|
|
version: 1
|
|
project:
|
|
name: "My Project"
|
|
type: "go"
|
|
branches:
|
|
main: "main"
|
|
feature_prefix: "feature/"
|
|
compliance:
|
|
require_approvals: true
|
|
require_branch: true
|
|
require_qa: true
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
- [CLI Reference](./cli-reference.md) - Full command documentation
|
|
- [API Reference](./api-reference.md) - REST API endpoints
|
|
- [Command Catalog](./command-catalog.md) - Claude Code commands for SDLC
|