Problem Statement
The folder structure and namespaces need to be updated to match the information in docs/design/introduction.md
Proposed Solution
The layout of the code in this project (both src and test) should be adjusted to follow the conventions defined in the docs/design/introduction.md file. This will also involve adding using statements.
Once that's done the design documentation should be updated to include documents for:
- "system.md" - the FileAssert system design documentation
- "{subsystem}.md" - design documentation for all subsystems
- "{unit}.md" - design documentation for all units
Then the requirements should also be revisited and updated - it seems there are no requirements for the subsystems. Adding these requirements will necessitate the creation of subsystem tests.
Alternatives Considered
No response
Usage Examples
Benefits
Proper structuring of requirements, design, code, and tests.
Priority
High - Blocking my use case
Willingness to Contribute
Yes, I can submit a pull request
Additional Context
No response
Checklist
Problem Statement
The folder structure and namespaces need to be updated to match the information in docs/design/introduction.md
Proposed Solution
The layout of the code in this project (both src and test) should be adjusted to follow the conventions defined in the docs/design/introduction.md file. This will also involve adding using statements.
Once that's done the design documentation should be updated to include documents for:
Then the requirements should also be revisited and updated - it seems there are no requirements for the subsystems. Adding these requirements will necessitate the creation of subsystem tests.
Alternatives Considered
No response
Usage Examples
Benefits
Proper structuring of requirements, design, code, and tests.
Priority
High - Blocking my use case
Willingness to Contribute
Yes, I can submit a pull request
Additional Context
No response
Checklist