Clarify OtsSoftwareTests and improve project overview and hierarchy#17
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s standards and automation guidance to make documentation structure more consistent and template-driven, with a particular emphasis on (1) correctly classifying subsystem vs. unit artifacts and (2) standardizing OTS test project naming/placement.
Changes:
- Clarifies that subsystem/unit classification must be determined from
docs/design/introduction.md(not folder depth) in design/verification/requirements standards and in the template-sync agent. - Reworks
reqstream-usage.mdto describe a stricter requirements-section hierarchy and adds tags/filtering guidance and an updated submission checklist. - Standardizes OTS test project naming/location and adjusts C++ folder/testing structure documentation accordingly.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/AGENTS.md | Expands “Project Overview” metadata keys intended for downstream customization/placeholders. |
| src/.github/standards/verification-documentation.md | Adds explicit guidance to classify subsystem vs unit via docs/design/introduction.md, not path depth. |
| src/.github/standards/software-items.md | Clarifies OTS test project naming/location as a fixed repo-level convention. |
| src/.github/standards/reviewmark-usage.md | Updates OTS review file-path patterns to reflect the standardized OTS test project location. |
| src/.github/standards/reqstream-usage.md | Rewrites requirements hierarchy/sections guidance, adds tags/filtering section, and updates the checklist. |
| src/.github/standards/design-documentation.md | Adds the same subsystem-vs-unit classification clarification as verification/design standards. |
| src/.github/standards/cpp-testing.md | Updates C++ test folder naming convention to {system_name}_tests/. |
| src/.github/standards/cpp-language.md | Renames/expands the “Header Organization” section into broader C++ project file organization guidance. |
| src/.github/agents/template-sync.agent.md | Enhances orchestration context (standards matrix + subsystem/unit classification source) and overhauls Recreate mode + reporting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/Agents/sessions/1bd74ee2-beba-4438-ab52-c02398310155 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/Agents/sessions/56a8ea1a-5149-4089-8502-cfd48abce27e Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot there are multiple review comments where a {system-name}/**/*.md pattern may be simpler |
Agent-Logs-Url: https://github.com/demaconsulting/Agents/sessions/2eda5e19-abc6-4825-aaf3-ec6ccb391723 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Applied this simplification across the relevant standards notes: path examples now use |
Agent-Logs-Url: https://github.com/demaconsulting/Agents/sessions/ce70b3ba-c4f4-4d31-9d8f-66d62197f205 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
This pull request introduces significant improvements to standards, documentation, and automation for template synchronization and project structure. The main focus is on clarifying the classification of subsystems and units, standardizing file organization, refining requirements file structure, and enhancing automation instructions for template-driven documentation. These changes help ensure consistency, accuracy, and maintainability across the repository.
Template Sync & Automation Enhancements
template-sync.agent.mdto:docs/design/introduction.mdto determine if items are subsystems or units, rather than inferring from folder depth, when selecting templates fordocs/design/,docs/verification/, anddocs/reqstream/.TEMPLATE-DIRECTIVEblocks, gathers content from all relevant sources, and adds a mandatory self-check for content format compliance.Standards: Subsystem/Unit Classification
design-documentation.md,verification-documentation.md, andreqstream-usage.mdthat classification of files as subsystems or units must always be determined fromdocs/design/introduction.md, not from folder depth. [1] [2] [3] [4] [5]Requirements Documentation Structure
reqstream-usage.md:File and Test Organization
cpp-language.md.cpp-testing.mdto use{system_name}_tests/and{unit_name}_tests.cpp.software-items.mdandreviewmark-usage.md. [1] [2]Project Metadata Placeholders
AGENTS.mdto define canonical placeholders for project-wide metadata (e.g., project name, organization, tagline, languages, technologies).