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
43
examples/contracts/workplan.contract.md
Normal file
43
examples/contracts/workplan.contract.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: Workplan Contract
|
||||
version: "0.1"
|
||||
---
|
||||
|
||||
# Workplan Contract
|
||||
|
||||
```yaml contract
|
||||
id: workplan-contract-v1
|
||||
document:
|
||||
type: workplan
|
||||
fields:
|
||||
id:
|
||||
type: string
|
||||
required: true
|
||||
status:
|
||||
type: string
|
||||
required: true
|
||||
enum: [proposed, active, done, deferred]
|
||||
sections:
|
||||
- id: purpose
|
||||
title: Purpose
|
||||
presence: required
|
||||
level: 2
|
||||
- id: tasks
|
||||
title: Tasks
|
||||
presence: required
|
||||
level: 2
|
||||
assertions:
|
||||
- id: tasks-have-task-blocks
|
||||
contains: "status:"
|
||||
severity: error
|
||||
- id: decision-point
|
||||
title: Decision Point
|
||||
presence: recommended
|
||||
level: 2
|
||||
metrics:
|
||||
document:
|
||||
sections:
|
||||
min: 2
|
||||
max: 12
|
||||
severity: warning
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue