Skip to content

README.md

Latest commit

 

History

History
220 lines (150 loc) · 5.4 KB

README.md

File metadata and controls

220 lines (150 loc) · 5.4 KB

Reference Documentation

Quick lookup guides for SDP commands, configuration, and quality standards.

CLI reference: ../CLI_REFERENCE.md — key sdp commands.

Contents

Commands

SDP CLI Commands

Core Commands:

  • @feature - Create new feature
  • @design - Plan workstreams
  • @build - Execute workstream
  • @review - Quality review
  • @deploy - Deploy to production
  • @oneshot - Autonomous execution

Utility Commands:

  • /debug - Systematic debugging
  • @issue - Bug routing
  • @hotfix - Emergency fix (P0)
  • @bugfix - Quality fix (P1/P2)

See: ../CLI_REFERENCE.md — SDP CLI commands

Reality OSS

Local single-repo reality baseline for OSS users:

  • sdp reality emit-oss
  • sdp reality validate
  • docs/specs/reality/OSS-SPEC.md
  • docs/specs/reality/ARTIFACT-CONTRACT.md

See: reality-oss.md — command surface, outputs, and publish checklist

Quality Gates

Mandatory Checks

Every workstream must pass:

  1. TDD - Tests written before implementation
  2. Coverage ≥80% - Test coverage threshold
  3. mypy --strict - Full type hint compliance
  4. ruff - Code linting
  5. File Size <200 LOC - Keep code focused
  6. No Bare Exceptions - Explicit error handling

See: build-spec.md - Complete quality standards

Configuration

Quality Gate Configuration

File: quality-gate.toml

[coverage]
minimum = 80

[complexity]
max_cc = 10

[file_size]
max_lines = 200

[type_hints]
strict_mode = true

See: ../PROTOCOL.md — Protocol and config

Pipeline Hooks Security

Pipeline hooks run executable commands in build/review/ci phases and are validated in fail-closed mode.

  • shell metacharacters are rejected
  • executables must be allowlisted or repository-local scripts
  • on_fail policy controls halt/warn/ignore behavior

See: pipeline-hooks-security.md — secure hook execution rules

Error Handling

SDP Error Framework

Structured errors with:

  • Category classification
  • Remediation steps
  • Documentation links
  • Context information

Error Types:

  • BeadsNotFoundError - Task not found
  • CoverageTooLowError - Coverage below threshold
  • QualityGateViolationError - Quality gate failed
  • WorkstreamValidationError - Validation failed
  • ConfigurationError - Config invalid
  • DependencyNotFoundError - Dependency missing
  • HookExecutionError - Hook failed
  • TestFailureError - Tests failed
  • BuildValidationError - Build check failed
  • ArtifactValidationError - Artifact invalid

See: skills.md — Skill contracts and error handling

Hydration

Context Packet Reliability

  • Deterministic pre-build/pre-review context packet generation
  • Fail-fast read of required quality-gate source (AGENTS.md)
  • Explicit ERROR: capture for dependency and drift collection failures
  • Injectable invoker seams for deterministic unit tests

See: context-hydration.md — hydration guarantees and testability contract

Schema Registry

Contracts and Findings

  • Protocol contracts: schema/contracts/*.schema.json
  • CI findings contracts: schema/findings/*.schema.json
  • Agent handoff contracts: schema/handoff-*.schema.json

See: schema-registry.md — schema families and usage map

Integration Contracts

End-to-End Usage

  • Runtime events and decisions: schema/contracts/*.schema.json
  • CI findings and examples: schema/findings/*.schema.json, schema/findings/examples/*.json
  • Cross-agent handoffs: schema/handoff-*.schema.json
  • Evidence provenance (prompt_hash, context_sources): schema/evidence-envelope.schema.json

See: integration-contracts.md — integration playbook and rollout checklist

Skills

Available Skills

Feature Development:

  • feature - Unified entry point
  • idea - Requirements gathering
  • design - Workstream planning
  • build - Execute workstream
  • review - Quality check
  • deploy - Production deployment

Utilities:

  • oneshot - Autonomous execution
  • debug - Systematic debugging
  • issue - Bug routing
  • hotfix - Emergency fix
  • bugfix - Quality fix

Internal:

  • tdd - TDD enforcement (automatic)

See: skills.md — Skill catalog

Quick Find

Looking For...

Need Doc
Command syntax ../CLI_REFERENCE.md
Reality OSS usage and checklist reality-oss.md
Quality standards build-spec.md
Hook security rules pipeline-hooks-security.md
Schema map schema-registry.md
Contracts usage guide integration-contracts.md
Skill details skills.md
Design workflow design-spec.md
Review workflow review-spec.md

Version: SDP v0.9.8 | Updated: 2026-02-26