Skip to content

[Feature]: Self-validation names and depth #34

@Malcolmnixon

Description

@Malcolmnixon

Problem Statement

The Self-validation output report is showing test descriptions rather than the test names, and the tool is missing a --depth parameter to specify markdown depth.

Proposed Solution

Add a '--depth <#>' argument to the tool to specify the markdown header depth of the self-validation report, and then modify the markdown output to show the test names.

Observe the example self-validation output in https://github.com/demaconsulting/ReviewMark/blob/main/README.md for compliant output on a different DEMA Consulting tool.

Remember to update the README.md, user_guide, requirements, design-documentation, and any tests that may be verifying the self-validation output.

Alternatives Considered

No response

Usage Examples

Benefits

Better integration with user workflows.

Priority

Medium - Would improve my workflow

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

  • I have searched existing issues to ensure this is not a duplicate
  • I have provided a clear description of the feature
  • I have explained why this feature would be useful

Metadata

Metadata

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions