Skip to content

Add ARCHITECTURE.md documenting internal design and processing flows#64

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/add-architecture-documentation
Jan 11, 2026
Merged

Add ARCHITECTURE.md documenting internal design and processing flows#64
Malcolmnixon merged 4 commits intomainfrom
copilot/add-architecture-documentation

Conversation

Copy link
Contributor

Copilot AI commented Jan 11, 2026

  • Create ARCHITECTURE.md explaining ReqStream's architecture
    • Document core data model (Requirement, Section, Requirements)
    • Explain reading and merging requirements workflow
    • Document trace matrix construction and analysis
    • Explain test coverage enforcement mechanism
    • Include architectural diagrams (using markdown)
  • Update AGENTS.md to reference ARCHITECTURE.md
  • Update .github/agents/*.md files to reference ARCHITECTURE.md
  • Run linters and verify changes (all passed)
  • Run code review and security scanning (no issues found)
  • Add ARCHITECTURE.md to Project Structure tree diagram
Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature]: Architecture Documentation</issue_title>
<issue_description>### Problem Statement

An ARCHITECTURE.md file needs to be created which explains the architecture of the ReqStream tool.

Proposed Solution

Create an ARCHITECTURE.md file which explains the working of the ReqStream tool.

Of importance is explaining the process by which ReqStream performs its core functional tasks of:

  • Reading and merging requirements
  • Constructing a trace matrix and analyzing test results
  • Enforcing test coverage

The architectural explanations should make it easy to explain exactly how the tool performs its core function - however if the explanation is complex because the functionality is complex, then consider if there are changes to the implementation which would make the code and corresponding architectural explanations simpler. These changes may be as simple as renaming functions, or possibly altering the execution flow.

Alternatives Considered

No response

Additional Context

It may also be appropriate to add a reference to the ARCHITECTURE.md to the AGENTS.md suggesting the ARCHITECTURE should be reviewed for details on the behavior of the tool.

Additionally it may be appropriate to update some of the GitHub agent files to have them consider the ARCHITECTURE.md in their work.

Priority

Medium - Would improve workflow

Contribution

  • I would be willing to submit a PR for this feature

Code of Conduct

  • I agree to follow this project's Code of Conduct</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 11, 2026 04:32
- Create detailed architecture documentation covering:
  - Core data model (Requirement, Section, Requirements, TraceMatrix, etc.)
  - Requirements processing flow (YAML parsing, section merging, validation)
  - Trace matrix construction and analysis
  - Test coverage enforcement mechanisms
  - Program execution flow and error handling
  - Implementation notes and design decisions

- Add reference to ARCHITECTURE.md in README.md Development section
- Include design rationale for key architectural patterns
- Document test name matching (plain vs source-specific)
- Explain child requirement transitive test coverage
- Add detailed flow diagrams and examples throughout

This provides the authoritative source for understanding ReqStream's behavior
and internal design for contributors and maintainers.
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Add architecture documentation for ReqStream tool Add ARCHITECTURE.md documenting internal design and processing flows Jan 11, 2026
Copilot AI requested a review from Malcolmnixon January 11, 2026 04:38
Copy link
Contributor

@Malcolmnixon Malcolmnixon left a comment

Choose a reason for hiding this comment

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

Consider adding the ARCHITECTURE.md file to the Project Structure of the AGENTS.md file

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

Copilot AI commented Jan 11, 2026

Consider adding the ARCHITECTURE.md file to the Project Structure of the AGENTS.md file

Added ARCHITECTURE.md to the Project Structure tree diagram in commit dfb56d6.

@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 11, 2026 04:42
@Malcolmnixon Malcolmnixon merged commit 2bda5be into main Jan 11, 2026
13 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-architecture-documentation branch January 11, 2026 04:47
Copilot AI added a commit that referenced this pull request Mar 26, 2026
- Add .gitattributes to enforce LF line endings (PR #71)
- Rename agent files to .agent.md naming convention (PR #61/#65)
- Add tools: and user-invocable: true to all agent frontmatter (PR #73)
- Use kebab-case name: fields in agent frontmatter
- Replace .cspell.json with .cspell.yaml (YAML format with policy comments) (PR #61/#63)
- Replace .markdownlint-cli2.jsonc with .markdownlint-cli2.yaml (PR #61)
- Update .yamllint.yaml ignore patterns with thirdparty dirs (PR #64)
- Update lint ignore paths with better glob patterns (PR #64)
- Add spell check word list policy to AGENTS.md (PR #63)
- Add Spell Checking section to CONTRIBUTING.md (PR #63)
- Update Defer To sections to Subagent Delegation pattern (PR #65)
- Fix linting config file name references in agent files
Copilot AI added a commit that referenced this pull request Mar 26, 2026
Apply all missing changes from the TemplateDotNetTool template to bring
ReqStream into consistency with the latest template patterns.

Changes applied from PRs #58-#74:

PR #58 (ReviewMark integration):
- Add .reviewmark.yaml with ReqStream-specific review sets
- Add pip-requirements.txt (yamllint==1.38.0)
- Update lint.sh/lint.bat to use Python venv + pip pattern
- Update package.json with pinned cspell and markdownlint-cli2 devDependencies
- Add demaconsulting.reviewmark to .config/dotnet-tools.json
- Add reviewmark entry to .versionmark.yaml

PR #59 (Add Code Review Agent to AGENTS.md invocation rules):
- Add code-review agent to AGENTS.md available agents list
- Add new .github/agents/code-review.agent.md

PR #61 (Linting modernization and agent file standardization):
- Update .markdownlint-cli2.yaml with PURPOSE/DO NOT MODIFY header
- Update .yamllint.yaml with PURPOSE/DO NOT MODIFY header
- Remove check-keys from yamllint truthy rule (aligns with template)

PR #63 (enforce cspell word list policy):
- Update .cspell.yaml header comment (NEVER add misspelled word)
- Add missing technical terms to cspell word list (reviewmark, ReviewMark,
  versionmark, VersionMark, buildmark, BuildMark, gitattributes, etc.)

PR #64 (Align lint YAML configs):
- Apply standardized headers to markdownlint and yamllint configs

PR #65-#67, #70-#73 (Agent synchronization):
- Update code-quality.agent.md to template version (comprehensive content)
- Update agent frontmatter descriptions to match shorter template pattern
- Update repo-consistency agent and requirements, software-developer,
  technical-writer, test-developer agents

PR #71 (.gitattributes LF line endings):
- .gitattributes already had correct content

PR #72 (Simplify repo-consistency agent):
- repo-consistency.agent.md already aligned

PR #54 (Various improvements):
- Update .versionmark.yaml regex patterns to support pre-release versions
- Update .gitignore to match template structure

CONTRIBUTING.md:
- Rewrite to match template standards with ReqStream-specific translation
- Add dotnet tool restore step, XML documentation section
- Add comprehensive testing guidelines with MSTest v4 assertions
- Add requirements management section
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.

[Feature]: Architecture Documentation

2 participants