Skip to content

Sync compliance docs and lint templates with TemplateDotNetLibrary PR #67#33

Merged
Malcolmnixon merged 9 commits intomainfrom
copilot/update-compliance-documentation-templates
Mar 30, 2026
Merged

Sync compliance docs and lint templates with TemplateDotNetLibrary PR #67#33
Malcolmnixon merged 9 commits intomainfrom
copilot/update-compliance-documentation-templates

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 29, 2026

Propagates the "extensive agent and lint cleanup" from TemplateDotNetLibrary#67 into the ContinuousCompliance documentation and templates.

Lint templates (templates/lint/)

  • lint.sh / lint.bat: quieter installs and spell-check (--silent, --quiet --disable-pip-version-check, cspell --quiet); npm install and pip install failures now propagate into the lint error flag so the script exits non-zero when dependencies fail to install
  • .cspell.yaml: exclude **/.agent-logs/** from spell checking
  • .gitignore: ignore .agent-logs/
  • .markdownlint-cli2.yaml: replaced AGENT_REPORT_*.md ignore with **/.agent-logs/** to match the new agent-log folder convention

templates/reviews/

  • .reviewmark.yaml: removed --definition flag from USAGE comment; updated output paths from docs/reviewplan/review-plan.md / docs/reviewreport/review-report.md to docs/code_review_plan/plan.md / docs/code_review_report/report.md

templates/reqstream/

  • Added docs/reqstream/system-example.yaml — example software system requirements file covering end-to-end/integration-tested behaviors; requirement IDs follow the Project-System-ShortDescription convention (e.g., TemplateTool-System-Version, TemplateTool-System-ExitCode)
  • Updated requirements.yaml to include the new system-example.yaml

docs/agentic.md

  • Restructured document: reframed from "how to set up agent guidance files" to "why Continuous Compliance helps agentic development" — opens with the vibe-coding problem, explains the context-window scaling problem, then shows how CC provides layer-by-layer machine-readable context agents can load selectively
  • Layer table: converted to Pandoc grid-table format so lengthy file-list cells wrap naturally within columns, keeping all source lines under the markdownlint line-length limit
  • Example AGENTS.md: generic compliance-focused structure pointing agents to requirements.yaml, .reviewmark.yaml, lint configs, and .editorconfig — documents every Continuous Compliance project has, regardless of agent tooling
  • Additional guidance files: generic description of how projects can place detailed guidance files alongside their code for agents to load when relevant
  • Agent logs: replaced AGENT_REPORT_*.md scratch-file pattern with .agent-logs/<agent><subject><id>.md folder convention

docs/requirements.md

  • Added Software System as a fourth requirement class (alongside Subsystem/Unit/OTS), covering the complete product boundary tested via integration/end-to-end tests
  • Added recommended file naming convention: {project}-system.yaml, subsystem-{name}.yaml, unit-{name}.yaml, ots-{component}.yaml
  • Added link to the new system-example.yaml template file

docs/file-reviews.md

  • Updated .reviewmark.yaml example needs-review to use docs/design/**/*.md instead of **/*.md to avoid matching generated review documents and other unrelated Markdown; removed now-unnecessary exclusions for code_review_plan/code_review_report
  • Updated all document folder paths to align with the technical-documentation standard: docs/code_review_plan/plan.md and docs/code_review_report/report.md (previously docs/reviewplan/review-plan.md and docs/reviewreport/review-report.md)
  • Updated folder structure table, directory tree, Pandoc definition.yaml examples, CI/CD integration commands, and Generated Documents examples to use the new paths throughout
  • Added Standard Review-Set Patterns section documenting the four canonical review-set types, formatted as a Pandoc grid-table so the lengthy "Contents" cells wrap within columns

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI changed the title [WIP] Update continuous compliance documentation and templates Sync compliance docs and lint templates with TemplateDotNetLibrary PR #67 Mar 29, 2026
Copilot AI requested a review from Malcolmnixon March 29, 2026 22:09
… folder names

Agent-Logs-Url: https://github.com/demaconsulting/ContinuousCompliance/sessions/6434256e-8582-4d3a-8c56-b2839b10cfcc

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 29, 2026 22:55
Copilot AI review requested due to automatic review settings March 29, 2026 22:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Propagates updates from TemplateDotNetLibrary#67 into this repo’s lint templates and Continuous Compliance documentation, focusing on quieter lint runs, agent log handling, and updated compliance/review documentation conventions.

Changes:

  • Quieted lint dependency installs and cspell output in templates/lint/ scripts.
  • Updated lint/spellcheck ignore rules to exclude .agent-logs/.
  • Refreshed documentation for agentic workflows, requirement classes (adding “Software System”), and ReviewMark/review document path conventions.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
templates/lint/lint.sh Makes npm/pip installs quieter; runs cspell with --quiet.
templates/lint/lint.bat Same as lint.sh for Windows batch usage.
templates/lint/.gitignore Adds .agent-logs/ to ignored paths.
templates/lint/.cspell.yaml Excludes **/.agent-logs/** from spell checking.
docs/requirements.md Adds “Software System” requirement class and recommends naming conventions including {project}-system.yaml.
docs/file-reviews.md Updates ReviewMark examples (needs-review patterns, review-set patterns, and new docs/code_review_* output paths).
docs/agentic.md Restructures agent guidance narrative; switches agent report convention to .agent-logs/.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot apply changes based on the comments in this thread

…eeds-review pattern, system example

Agent-Logs-Url: https://github.com/demaconsulting/ContinuousCompliance/sessions/c5e511f3-b4e6-470f-b626-144b501314d6

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 29, 2026

@copilot apply changes based on the comments in this thread

All changes from the review thread applied in commit 061e946: markdownlint now ignores .agent-logs/**; .reviewmark.yaml template uses the updated paths; needs-review example uses docs/design/**/*.md; system-level requirements example added.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 7 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot apply changes based on the comments in this thread

…to lint scripts

Agent-Logs-Url: https://github.com/demaconsulting/ContinuousCompliance/sessions/f6b32da2-e179-4dde-a0e5-b6bf6748986a

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 29, 2026

@copilot apply changes based on the comments in this thread

All changes from the review thread applied in commit c7c66a5: both long tables converted to grid-table format, and npm install / pip install in lint.sh and lint.bat now propagate errors into the lint error flag.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 30, 2026

@copilot apply changes based on the comments in this thread

Updated system-example.yaml in commit 3faf281 — requirement IDs now follow the Project-System-ShortDescription convention: TemplateTool-System-Version and TemplateTool-System-ExitCode.

@Malcolmnixon Malcolmnixon merged commit c80a4f1 into main Mar 30, 2026
@Malcolmnixon Malcolmnixon deleted the copilot/update-compliance-documentation-templates branch March 30, 2026 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants