Comprehensive documentation update using SarifMark template

[Copilot]

Pull Request

Description

Expanded project documentation from minimal placeholder to production-ready content. Used SarifMark repository structure as template, adapted for BuildMark's specific features (build notes generation, Git integration, GitHub issue tracking).

Changes:

• README.md: Added badges, comprehensive overview, installation guide (global/local/update), usage examples, command-line options reference, self-validation documentation, report format specification, and support sections. Uses absolute URLs (required for NuGet package inclusion).

• CONTRIBUTING.md: Development setup, coding standards (.editorconfig compliance), MSTest v4 testing guidelines, documentation requirements (markdown/spell/YAML linting), quality checks, and PR process. Uses reference-style links.

• CODE_OF_CONDUCT.md: Community guidelines with behavior expectations, reporting procedures, and enforcement policy.

• SECURITY.md: Vulnerability reporting process via GitHub security advisory only, supported versions policy, response timelines, security best practices, and update procedures.

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

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 tests pass: dotnet test --configuration Release
• 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

All 84 existing tests pass across .NET 8, 9, and 10. No code changes required. One spell check note: "myterm" in CONTRIBUTING.md is an intentional example placeholder.

Custom agent used: Documentation Writer
Expert agent for BuildMark documentation, requirements.yaml maintenance, and markdown/spell/YAML linting

Original prompt

Please review and update the documentation for the project. This includes fleshing out the README.md. Please use https://github.com/demaconsulting/SarifMark as a template for this, but obviously updated for BuildMark usage.

Custom agent used: Documentation Writer
Expert agent for BuildMark documentation, requirements.yaml maintenance, and markdown/spell/YAML linting

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.