Add ARCHITECTURE.md documenting internal design and processing flows#64
Merged
Malcolmnixon merged 4 commits intomainfrom Jan 11, 2026
Merged
Conversation
- 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
Malcolmnixon
requested changes
Jan 11, 2026
Contributor
Malcolmnixon
left a comment
There was a problem hiding this comment.
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>
Contributor
Author
Added ARCHITECTURE.md to the Project Structure tree diagram in commit dfb56d6. |
Malcolmnixon
approved these changes
Jan 11, 2026
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
23 tasks
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.