Add self-validation test descriptions to README and user guide#160
Add self-validation test descriptions to README and user guide#160Malcolmnixon merged 5 commits intomainfrom
Conversation
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot Please shorten the Self-validation bullet-list descriptions so they fit on one line. |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
… README Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Done in 8bdcba3 — all descriptions are now on one line. The longer descriptions were moved to a new "Validation Tests" section in the user guide (86fe8ab), and the README now links to the user guide for more details. |
README.md
Outdated
|
|
||
| Each test in the report proves a specific command works correctly: | ||
|
|
||
| - **SpdxTool_AddPackage** - Proves the `add-package` command adds a package with relationships to an SPDX document. |
There was a problem hiding this comment.
Seeing as the heading above the bullet list talks about "proves", we can drop "Proves the" from each bullet.
Let's replace "SPDX document" with "SPDX file" in all of these.
There was a problem hiding this comment.
Done in f68ffa2 — dropped "Proves the" from all bullets and replaced "SPDX document" with "SPDX file" throughout.
…DX file' Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
The README Self Validation section showed example output listing test names but gave no indication of what each test actually validates, leaving readers to infer purpose from names alone. The user guide lacked any description of the individual self-validation tests.
Pull Request
Description
## Validation Testssection with detailed multi-line descriptions for each of the 14 self-validation tests, explaining what inputs are used, which command is exercised, and what is verified in the output.Type of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.SpdxTool --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
Additional Notes
Documentation-only change. No code, tests, or build configuration modified.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.