-
Notifications
You must be signed in to change notification settings - Fork 19
Add Decision Record support #236
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //src:license-checkStatus: ✅ Passed Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces Decision Record support to formalize decision-making processes in the Docs-As-Code workflow. The implementation adds a new dec_rec need type to the metamodel with structured fields for context, decisions, status, and consequences.
- Adds
dec_recneed type to the metamodel with mandatory fields for ID, status, context, and decision - Updates ID validation to exempt decision records from feature-based location requirements
- Migrates existing decision record from YAML frontmatter to the new structured format
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/extensions/score_metamodel/metamodel.yaml | Defines the new dec_rec need type with required and optional fields |
| src/extensions/score_metamodel/checks/id_contains_feature.py | Exempts decision records from feature-based ID validation |
| docs/internals/decisions_and_concepts/index.rst | Adds a table to display decision records |
| docs/internals/decisions_and_concepts/001-test-results-in-workflow.md | Converts existing decision record to new format |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
FScholPer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good
Introduce a new decision record type and update the relevant functions to handle decision records in the Docs-As-Code workflows. This change enhances the documentation process by formalizing decision-making records.