coulomb/markitect-tool
2
0
Fork 0
generated from coulomb/repo-seed
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Contract framework with markdown-native contracts utilizing fenced YAML blocks

Browse Source
This commit is contained in:
Bernd Worsch
2026-05-03 22:51:13 +02:00
parent 3cfda33bc9
commit e3e13ee45a
36 changed files with 2877 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
examples/diagnostics/adr-invalid.expected-diagnostics.md Normal file
View File

@@ -0,0 +1,8 @@
# Expected Diagnostics: adr-invalid.md
- `contract.field.missing`: `status` is required.
- `contract.metric.too_low`: the document is below the target word band.
- `contract.assertion.contains_any_missing`: context does not mention problem, motivation, or constraint.
- `contract.section.missing`: `decision` is required.
- `contract.section.recommended_missing`: `consequences` is recommended.
- `contract.section.forbidden`: `deprecated` is present.

5
examples/diagnostics/business-letter-invalid.expected-diagnostics.md Normal file
View File

@@ -0,0 +1,5 @@
# Expected Diagnostics: business-letter-invalid.md
- `contract.field.missing`: `sender_name` is required.
- `contract.section.missing`: `closing` is required.
- `contract.metric.too_low`: the `Body` section is below the target word band.

5
examples/diagnostics/concept-note-invalid.expected-diagnostics.md Normal file
View File

@@ -0,0 +1,5 @@
# Expected Diagnostics: concept-note-invalid.md
- `contract.field.enum`: `status` must be one of the allowed lifecycle values.
- `contract.metric.too_low`: the document is below the target word band.
- `contract.section.missing`: `assertions` is required.

8
examples/diagnostics/prd-frs-invalid.expected-diagnostics.md Normal file
View File

@@ -0,0 +1,8 @@
# Expected Diagnostics: prd-frs-invalid.md
- `contract.field.missing`: `owner` is required.
- `contract.metric.too_low`: the document is below the target word band.
- `contract.assertion.contains_any_missing`: goals do not mention measure, metric, or success.
- `contract.section.missing`: `functional-requirements` is required.
- `contract.section.recommended_missing`: `non-goals` is recommended.
- `contract.section.discouraged`: `implementation-plan` is discouraged in this contract.

6
examples/diagnostics/workplan-invalid.expected-diagnostics.md Normal file
View File

@@ -0,0 +1,6 @@
# Expected Diagnostics: workplan-invalid.md
- `contract.field.missing`: `id` is required.
- `contract.field.enum`: `status` must be one of the allowed lifecycle values.
- `contract.assertion.contains_missing`: the `Tasks` section lacks task metadata.
- `contract.section.recommended_missing`: `decision-point` is recommended.