Skip to content

Comments

Fix README.md JSON format examples to match implementation#23

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/fix-readme-content
Feb 15, 2026
Merged

Fix README.md JSON format examples to match implementation#23
Malcolmnixon merged 2 commits intomainfrom
copilot/fix-readme-content

Conversation

Copy link
Contributor

Copilot AI commented Feb 15, 2026

Pull Request

Description

The README.md contained incorrect JSON format examples that didn't match the actual VersionInfo implementation.

JSON Capture Output:

  • Property names were kebab-case (job-id, versions) instead of PascalCase (JobId, Versions)
  • Included non-existent timestamp field

Markdown Publish Output:

  • Showed (All jobs) text and <sub> tags that don't exist in actual output
  • Actual format: uniform versions show no job IDs; conflicts show separate bullets with parentheses
# Before (incorrect)
- **gcc**: 11.4.0 <sub>(windows-net8)</sub>, 13.2.0 <sub>(linux-net8)</sub>

# After (correct)
- **gcc**: 11.4.0 (windows-net8)
- **gcc**: 13.2.0 (linux-net8)

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Related Issues

N/A

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.VersionMark --configuration Release --framework net10.0
    --no-build -- --validate
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Verified actual JSON/markdown output by running capture and publish commands. All 101 unit tests pass.


💡 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.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Review and correct README.md content Fix README.md JSON format examples to match implementation Feb 15, 2026
Copilot AI requested a review from Malcolmnixon February 15, 2026 15:53
@Malcolmnixon Malcolmnixon marked this pull request as ready for review February 15, 2026 15:59
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.

2 participants