Contract framework with markdown-native contracts utilizing fenced YAML blocks
This commit is contained in:
parent
3cfda33bc9
commit
e3e13ee45a
36 changed files with 2877 additions and 13 deletions
49
examples/contracts/prd-frs.contract.md
Normal file
49
examples/contracts/prd-frs.contract.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: PRD and FRS Contract
|
||||
version: "0.1"
|
||||
---
|
||||
|
||||
# PRD And FRS Contract
|
||||
|
||||
```yaml contract
|
||||
id: prd-frs-contract-v1
|
||||
document:
|
||||
type: prd-frs
|
||||
fields:
|
||||
product:
|
||||
type: string
|
||||
required: true
|
||||
owner:
|
||||
type: string
|
||||
required: true
|
||||
metrics:
|
||||
document:
|
||||
words:
|
||||
min: 300
|
||||
max: 4000
|
||||
severity: warning
|
||||
sections:
|
||||
- id: problem
|
||||
title: Problem
|
||||
presence: required
|
||||
level: 2
|
||||
- id: goals
|
||||
title: Goals
|
||||
presence: required
|
||||
level: 2
|
||||
assertions:
|
||||
- id: goals-are-testable
|
||||
contains_any: [measure, metric, success]
|
||||
severity: warning
|
||||
- id: functional-requirements
|
||||
title: Functional Requirements
|
||||
presence: required
|
||||
level: 2
|
||||
- id: non-goals
|
||||
title: Non-Goals
|
||||
presence: recommended
|
||||
level: 2
|
||||
- id: implementation-plan
|
||||
title: Implementation Plan
|
||||
presence: discouraged
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue