contract-driven-delivery 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +142 -0
- package/assets/AGENTS.template.md +21 -0
- package/assets/CLAUDE.template.md +159 -0
- package/assets/agents/backend-engineer.md +24 -0
- package/assets/agents/change-classifier.md +73 -0
- package/assets/agents/ci-cd-gatekeeper.md +40 -0
- package/assets/agents/contract-reviewer.md +42 -0
- package/assets/agents/e2e-resilience-engineer.md +25 -0
- package/assets/agents/frontend-engineer.md +22 -0
- package/assets/agents/monkey-test-engineer.md +29 -0
- package/assets/agents/qa-reviewer.md +49 -0
- package/assets/agents/repo-context-scanner.md +71 -0
- package/assets/agents/spec-architect.md +47 -0
- package/assets/agents/spec-drift-auditor.md +41 -0
- package/assets/agents/stress-soak-engineer.md +51 -0
- package/assets/agents/test-strategist.md +57 -0
- package/assets/agents/ui-ux-reviewer.md +42 -0
- package/assets/agents/visual-reviewer.md +44 -0
- package/assets/ci/gate-policy.md +51 -0
- package/assets/ci/github-actions/contract-driven-gates.yml +38 -0
- package/assets/ci/required-check-policy.md +13 -0
- package/assets/contracts/api/api-contract.md +20 -0
- package/assets/contracts/api/api-inventory.md +13 -0
- package/assets/contracts/api/error-format.md +19 -0
- package/assets/contracts/business/business-rules.md +13 -0
- package/assets/contracts/ci/ci-gate-contract.md +13 -0
- package/assets/contracts/css/css-contract.md +15 -0
- package/assets/contracts/css/design-tokens.md +13 -0
- package/assets/contracts/data/data-shape-contract.md +22 -0
- package/assets/contracts/env/.env.example.template +5 -0
- package/assets/contracts/env/env-contract.md +12 -0
- package/assets/contracts/env/env.schema.json +7 -0
- package/assets/skill/SKILL.md +102 -0
- package/assets/skill/agents/openai.yaml +2 -0
- package/assets/skill/references/api-contract-standard.md +55 -0
- package/assets/skill/references/business-logic-standard.md +32 -0
- package/assets/skill/references/ci-cd-policy.md +34 -0
- package/assets/skill/references/css-contract-standard.md +40 -0
- package/assets/skill/references/data-contract-standard.md +43 -0
- package/assets/skill/references/e2e-standard.md +33 -0
- package/assets/skill/references/env-contract-standard.md +30 -0
- package/assets/skill/references/monkey-operation-standard.md +32 -0
- package/assets/skill/references/qa-gates.md +37 -0
- package/assets/skill/references/sdd-tdd-policy.md +53 -0
- package/assets/skill/references/spec-drift-policy.md +28 -0
- package/assets/skill/references/stress-soak-standard.md +42 -0
- package/assets/skill/references/visual-review-standard.md +27 -0
- package/assets/skill/references/workflow-router.md +34 -0
- package/assets/skill/scripts/detect_project_profile.py +61 -0
- package/assets/skill/scripts/generate_change_scaffold.py +38 -0
- package/assets/skill/scripts/validate_ci_gates.py +14 -0
- package/assets/skill/scripts/validate_contracts.py +13 -0
- package/assets/skill/scripts/validate_env_contract.py +16 -0
- package/assets/skill/scripts/validate_spec_traceability.py +18 -0
- package/assets/skill/templates/archive.md +17 -0
- package/assets/skill/templates/change-classification.md +48 -0
- package/assets/skill/templates/change-request.md +15 -0
- package/assets/skill/templates/ci-gates.md +31 -0
- package/assets/skill/templates/contracts.md +37 -0
- package/assets/skill/templates/current-behavior.md +17 -0
- package/assets/skill/templates/design.md +23 -0
- package/assets/skill/templates/monkey-test-report.md +17 -0
- package/assets/skill/templates/project-profile.md +38 -0
- package/assets/skill/templates/proposal.md +17 -0
- package/assets/skill/templates/qa-report.md +26 -0
- package/assets/skill/templates/regression-report.md +21 -0
- package/assets/skill/templates/spec.md +23 -0
- package/assets/skill/templates/stress-soak-report.md +22 -0
- package/assets/skill/templates/tasks.md +43 -0
- package/assets/skill/templates/test-plan.md +31 -0
- package/assets/skill/templates/visual-review-report.md +33 -0
- package/assets/specs-templates/archive.md +17 -0
- package/assets/specs-templates/change-classification.md +48 -0
- package/assets/specs-templates/change-request.md +15 -0
- package/assets/specs-templates/ci-gates.md +31 -0
- package/assets/specs-templates/contracts.md +37 -0
- package/assets/specs-templates/current-behavior.md +17 -0
- package/assets/specs-templates/design.md +23 -0
- package/assets/specs-templates/monkey-test-report.md +17 -0
- package/assets/specs-templates/project-profile.md +38 -0
- package/assets/specs-templates/proposal.md +17 -0
- package/assets/specs-templates/qa-report.md +26 -0
- package/assets/specs-templates/regression-report.md +21 -0
- package/assets/specs-templates/spec.md +23 -0
- package/assets/specs-templates/stress-soak-report.md +22 -0
- package/assets/specs-templates/tasks.md +43 -0
- package/assets/specs-templates/test-plan.md +31 -0
- package/assets/specs-templates/visual-review-report.md +33 -0
- package/assets/tests-templates/data-boundary/malformed-data.spec.md +14 -0
- package/assets/tests-templates/e2e/critical-journey.spec.md +13 -0
- package/assets/tests-templates/monkey/operation-sequence.spec.md +11 -0
- package/assets/tests-templates/resilience/api-failure.spec.md +12 -0
- package/assets/tests-templates/soak/soak-profile.md +15 -0
- package/assets/tests-templates/stress/load-profile.md +15 -0
- package/bin/cdd.js +2 -0
- package/dist/cli/index.js +336 -0
- package/package.json +48 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Change Classification
|
|
2
|
+
|
|
3
|
+
## Change Types
|
|
4
|
+
- primary:
|
|
5
|
+
- secondary:
|
|
6
|
+
|
|
7
|
+
## Risk Level
|
|
8
|
+
- low / medium / high / critical
|
|
9
|
+
|
|
10
|
+
## Impact Radius
|
|
11
|
+
- isolated / module-level / cross-module / system-wide
|
|
12
|
+
|
|
13
|
+
## Required Artifacts
|
|
14
|
+
| artifact | required | reason |
|
|
15
|
+
|---|---:|---|
|
|
16
|
+
| current-behavior.md | | |
|
|
17
|
+
| proposal.md | | |
|
|
18
|
+
| spec.md | | |
|
|
19
|
+
| design.md | | |
|
|
20
|
+
| contracts.md | | |
|
|
21
|
+
| test-plan.md | yes | every implementation change requires test planning |
|
|
22
|
+
| ci-gates.md | yes | every implementation change requires CI/CD gate planning |
|
|
23
|
+
| qa-report.md | | |
|
|
24
|
+
| regression-report.md | | |
|
|
25
|
+
|
|
26
|
+
## Required Contracts
|
|
27
|
+
- API:
|
|
28
|
+
- CSS/UI:
|
|
29
|
+
- Env:
|
|
30
|
+
- Data shape:
|
|
31
|
+
- Business logic:
|
|
32
|
+
- CI/CD:
|
|
33
|
+
|
|
34
|
+
## Required Test Families
|
|
35
|
+
- unit:
|
|
36
|
+
- contract:
|
|
37
|
+
- integration:
|
|
38
|
+
- E2E:
|
|
39
|
+
- visual:
|
|
40
|
+
- data-boundary:
|
|
41
|
+
- resilience:
|
|
42
|
+
- fuzz/monkey:
|
|
43
|
+
- stress:
|
|
44
|
+
- soak:
|
|
45
|
+
|
|
46
|
+
## Required Agents
|
|
47
|
+
|
|
48
|
+
## Assumptions / Clarifications
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# CI/CD Gate Plan
|
|
2
|
+
|
|
3
|
+
## Change ID
|
|
4
|
+
|
|
5
|
+
## Required Gates
|
|
6
|
+
| gate | tier | required | trigger | command/workflow | expected artifact |
|
|
7
|
+
|---|---:|---:|---|---|---|
|
|
8
|
+
| lint | 1 | yes | pull_request | | |
|
|
9
|
+
| build | 1 | yes | pull_request | | |
|
|
10
|
+
| unit | 1 | yes | pull_request | | |
|
|
11
|
+
| contract | 1 | conditional | pull_request | | |
|
|
12
|
+
| integration | 1/3 | conditional | pull_request/nightly | | |
|
|
13
|
+
| e2e-critical | 1 | conditional | pull_request | | |
|
|
14
|
+
| visual | 2 | conditional | pull_request | | |
|
|
15
|
+
| data-boundary | 1 | conditional | pull_request | | |
|
|
16
|
+
| resilience | 1/3 | conditional | pull_request/nightly | | |
|
|
17
|
+
| fuzz/monkey | 1/3 | conditional | pull_request/nightly | | |
|
|
18
|
+
| stress | 4/5 | conditional | weekly/manual | | |
|
|
19
|
+
| soak | 4/5 | conditional | weekly/manual | | |
|
|
20
|
+
|
|
21
|
+
## New Workflow Changes
|
|
22
|
+
|
|
23
|
+
## Required Check Policy
|
|
24
|
+
|
|
25
|
+
## Informational Gate Promotion Policy
|
|
26
|
+
|
|
27
|
+
## Rollback Policy
|
|
28
|
+
|
|
29
|
+
## Artifact Retention
|
|
30
|
+
|
|
31
|
+
## Merge Eligibility Decision
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Contract Change Report
|
|
2
|
+
|
|
3
|
+
## API Contract
|
|
4
|
+
- changed:
|
|
5
|
+
- files:
|
|
6
|
+
- compatibility:
|
|
7
|
+
- tests:
|
|
8
|
+
|
|
9
|
+
## CSS/UI Contract
|
|
10
|
+
- changed:
|
|
11
|
+
- files:
|
|
12
|
+
- visual evidence required:
|
|
13
|
+
- tests:
|
|
14
|
+
|
|
15
|
+
## Env Contract
|
|
16
|
+
- changed:
|
|
17
|
+
- variables:
|
|
18
|
+
- public/private scope:
|
|
19
|
+
- deployment impact:
|
|
20
|
+
- tests:
|
|
21
|
+
|
|
22
|
+
## Data Shape Contract
|
|
23
|
+
- changed:
|
|
24
|
+
- required columns/types:
|
|
25
|
+
- malformed data behavior:
|
|
26
|
+
- tests:
|
|
27
|
+
|
|
28
|
+
## Business Logic Contract
|
|
29
|
+
- changed:
|
|
30
|
+
- decision table:
|
|
31
|
+
- regression tests:
|
|
32
|
+
|
|
33
|
+
## CI/CD Contract
|
|
34
|
+
- changed:
|
|
35
|
+
- gates:
|
|
36
|
+
- required checks:
|
|
37
|
+
- promotion policy:
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Technical Design
|
|
2
|
+
|
|
3
|
+
## Architecture Summary
|
|
4
|
+
|
|
5
|
+
## Affected Components
|
|
6
|
+
|
|
7
|
+
## API Design
|
|
8
|
+
|
|
9
|
+
## Data / Schema Design
|
|
10
|
+
|
|
11
|
+
## UI / UX Design
|
|
12
|
+
|
|
13
|
+
## Env / Config Design
|
|
14
|
+
|
|
15
|
+
## Error Handling
|
|
16
|
+
|
|
17
|
+
## Performance Considerations
|
|
18
|
+
|
|
19
|
+
## Security Considerations
|
|
20
|
+
|
|
21
|
+
## Deployment / Rollback
|
|
22
|
+
|
|
23
|
+
## Architecture Decision Notes
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Monkey Operation Test Report
|
|
2
|
+
|
|
3
|
+
## Target Feature
|
|
4
|
+
|
|
5
|
+
## Preventive Spec Cases
|
|
6
|
+
|
|
7
|
+
## Exploratory Operation Sequences
|
|
8
|
+
| id | sequence | expected safe outcome | result |
|
|
9
|
+
|---|---|---|---|
|
|
10
|
+
|
|
11
|
+
## Fuzz Payloads / Malformed Data
|
|
12
|
+
|
|
13
|
+
## Findings
|
|
14
|
+
|
|
15
|
+
## Required Fixes
|
|
16
|
+
|
|
17
|
+
## Regression Tests Added
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Project Profile
|
|
2
|
+
|
|
3
|
+
## Project Type
|
|
4
|
+
|
|
5
|
+
## Detected Stack
|
|
6
|
+
- languages:
|
|
7
|
+
- frontend:
|
|
8
|
+
- backend:
|
|
9
|
+
- database:
|
|
10
|
+
- cache/queue:
|
|
11
|
+
- storage:
|
|
12
|
+
- auth:
|
|
13
|
+
- styling:
|
|
14
|
+
- test frameworks:
|
|
15
|
+
- build/deploy:
|
|
16
|
+
|
|
17
|
+
## Important Paths
|
|
18
|
+
|
|
19
|
+
## Commands
|
|
20
|
+
- install:
|
|
21
|
+
- dev:
|
|
22
|
+
- build:
|
|
23
|
+
- lint:
|
|
24
|
+
- typecheck:
|
|
25
|
+
- unit:
|
|
26
|
+
- integration:
|
|
27
|
+
- e2e:
|
|
28
|
+
- contract:
|
|
29
|
+
- stress:
|
|
30
|
+
- soak:
|
|
31
|
+
|
|
32
|
+
## Existing Contracts
|
|
33
|
+
|
|
34
|
+
## CI/CD Workflows
|
|
35
|
+
|
|
36
|
+
## Missing or Weak Standards
|
|
37
|
+
|
|
38
|
+
## Recommended Next Steps
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# QA Report
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
|
|
5
|
+
## Gate Results
|
|
6
|
+
| gate | command/workflow | result | artifact/log |
|
|
7
|
+
|---|---|---|---|
|
|
8
|
+
|
|
9
|
+
## Functional Verification
|
|
10
|
+
|
|
11
|
+
## Contract Verification
|
|
12
|
+
|
|
13
|
+
## Visual / UX Verification
|
|
14
|
+
|
|
15
|
+
## E2E / Resilience Verification
|
|
16
|
+
|
|
17
|
+
## Stress / Soak Verification
|
|
18
|
+
|
|
19
|
+
## Known Risks
|
|
20
|
+
|
|
21
|
+
## Failures and Fixback Routing
|
|
22
|
+
| failure | evidence | owner | required fix |
|
|
23
|
+
|---|---|---|---|
|
|
24
|
+
|
|
25
|
+
## Decision
|
|
26
|
+
approved / blocked / approved-with-risk
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Regression Report
|
|
2
|
+
|
|
3
|
+
## Changed Areas
|
|
4
|
+
|
|
5
|
+
## Directly Affected Features
|
|
6
|
+
|
|
7
|
+
## Indirectly Affected Features
|
|
8
|
+
|
|
9
|
+
## Critical User Journeys Re-tested
|
|
10
|
+
|
|
11
|
+
## API Regression
|
|
12
|
+
|
|
13
|
+
## UI Regression
|
|
14
|
+
|
|
15
|
+
## Data / Business Logic Regression
|
|
16
|
+
|
|
17
|
+
## CI/CD Regression
|
|
18
|
+
|
|
19
|
+
## Spec Drift Findings
|
|
20
|
+
|
|
21
|
+
## Decision
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Specification
|
|
2
|
+
|
|
3
|
+
## User Stories / Scenarios
|
|
4
|
+
|
|
5
|
+
### Scenario 1
|
|
6
|
+
Given
|
|
7
|
+
When
|
|
8
|
+
Then
|
|
9
|
+
|
|
10
|
+
## Functional Requirements
|
|
11
|
+
|
|
12
|
+
## Non-functional Requirements
|
|
13
|
+
|
|
14
|
+
## Edge Cases
|
|
15
|
+
|
|
16
|
+
## Acceptance Criteria
|
|
17
|
+
|
|
18
|
+
| id | criterion | measurable signal |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
|
|
21
|
+
## Clarifications
|
|
22
|
+
|
|
23
|
+
## Open Risks
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Stress / Soak Report
|
|
2
|
+
|
|
3
|
+
## Workload Model
|
|
4
|
+
|
|
5
|
+
## Environment
|
|
6
|
+
|
|
7
|
+
## Duration
|
|
8
|
+
|
|
9
|
+
## Metrics Collected
|
|
10
|
+
|
|
11
|
+
## Thresholds
|
|
12
|
+
|
|
13
|
+
## Results
|
|
14
|
+
| metric | threshold | observed | result |
|
|
15
|
+
|---|---|---|---|
|
|
16
|
+
|
|
17
|
+
## Failures / Degradation
|
|
18
|
+
|
|
19
|
+
## Artifacts
|
|
20
|
+
|
|
21
|
+
## Recommendation
|
|
22
|
+
pass / fail / repeat-with-adjusted-load / promote-to-gate
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Tasks
|
|
2
|
+
|
|
3
|
+
## 1. Preparation
|
|
4
|
+
- [ ] 1.1 Confirm classification and required artifacts
|
|
5
|
+
- [ ] 1.2 Confirm contracts to update
|
|
6
|
+
- [ ] 1.3 Confirm CI/CD gate plan
|
|
7
|
+
|
|
8
|
+
## 2. Contract Updates
|
|
9
|
+
- [ ] 2.1 API contract
|
|
10
|
+
- [ ] 2.2 CSS/UI contract
|
|
11
|
+
- [ ] 2.3 Env contract
|
|
12
|
+
- [ ] 2.4 Data shape contract
|
|
13
|
+
- [ ] 2.5 Business logic contract
|
|
14
|
+
- [ ] 2.6 CI/CD contract
|
|
15
|
+
|
|
16
|
+
## 3. Tests First
|
|
17
|
+
- [ ] 3.1 Unit/contract tests
|
|
18
|
+
- [ ] 3.2 Integration tests
|
|
19
|
+
- [ ] 3.3 E2E/resilience tests
|
|
20
|
+
- [ ] 3.4 Data-boundary/monkey tests
|
|
21
|
+
- [ ] 3.5 Stress/soak tests if required
|
|
22
|
+
|
|
23
|
+
## 4. Implementation
|
|
24
|
+
- [ ] 4.1 Backend
|
|
25
|
+
- [ ] 4.2 Frontend
|
|
26
|
+
- [ ] 4.3 Env/deploy
|
|
27
|
+
- [ ] 4.4 CI/CD workflows
|
|
28
|
+
|
|
29
|
+
## 5. Review
|
|
30
|
+
- [ ] 5.1 UI/UX review
|
|
31
|
+
- [ ] 5.2 Visual review
|
|
32
|
+
- [ ] 5.3 Contract review
|
|
33
|
+
- [ ] 5.4 QA review
|
|
34
|
+
|
|
35
|
+
## 6. Verification
|
|
36
|
+
- [ ] 6.1 Local gates
|
|
37
|
+
- [ ] 6.2 PR required gates
|
|
38
|
+
- [ ] 6.3 Informational gates
|
|
39
|
+
- [ ] 6.4 Nightly/weekly/manual gates if required
|
|
40
|
+
|
|
41
|
+
## 7. Archive
|
|
42
|
+
- [ ] 7.1 Archive change
|
|
43
|
+
- [ ] 7.2 Promote durable learnings to contracts or CLAUDE.md
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Test Plan
|
|
2
|
+
|
|
3
|
+
## Acceptance Criteria Mapping
|
|
4
|
+
| requirement | test family | planned file/spec | expected evidence |
|
|
5
|
+
|---|---|---|---|
|
|
6
|
+
|
|
7
|
+
## Unit Tests
|
|
8
|
+
|
|
9
|
+
## Contract Tests
|
|
10
|
+
|
|
11
|
+
## Integration Tests
|
|
12
|
+
|
|
13
|
+
## E2E Tests
|
|
14
|
+
|
|
15
|
+
## Visual Tests / Review
|
|
16
|
+
|
|
17
|
+
## Data Boundary Tests
|
|
18
|
+
|
|
19
|
+
## Resilience Tests
|
|
20
|
+
|
|
21
|
+
## Fuzz / Monkey Operation Tests
|
|
22
|
+
|
|
23
|
+
## Stress Tests
|
|
24
|
+
|
|
25
|
+
## Soak Tests
|
|
26
|
+
|
|
27
|
+
## Mutation Checks
|
|
28
|
+
|
|
29
|
+
## Commands
|
|
30
|
+
|
|
31
|
+
## CI/CD Gate Mapping
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Visual Review Report
|
|
2
|
+
|
|
3
|
+
## Affected Screens
|
|
4
|
+
|
|
5
|
+
## Viewports Checked
|
|
6
|
+
- desktop:
|
|
7
|
+
- tablet:
|
|
8
|
+
- mobile:
|
|
9
|
+
|
|
10
|
+
## States Checked
|
|
11
|
+
- default:
|
|
12
|
+
- loading:
|
|
13
|
+
- empty:
|
|
14
|
+
- error:
|
|
15
|
+
- disabled:
|
|
16
|
+
- focus/keyboard:
|
|
17
|
+
- long text:
|
|
18
|
+
- no permission:
|
|
19
|
+
|
|
20
|
+
## Evidence
|
|
21
|
+
- screenshots:
|
|
22
|
+
- videos:
|
|
23
|
+
- traces:
|
|
24
|
+
- diff reports:
|
|
25
|
+
|
|
26
|
+
## CSS Contract Findings
|
|
27
|
+
|
|
28
|
+
## Accessibility Findings
|
|
29
|
+
|
|
30
|
+
## Required Fixes
|
|
31
|
+
|
|
32
|
+
## Decision
|
|
33
|
+
approved / changes-required
|
package/bin/cdd.js
ADDED