Skip to content

Add professional status badges to README header #258

@WilliamBerryiii

Description

@WilliamBerryiii

Summary

Add a minimal enterprise-focused badge strip at the top of the README (after frontmatter, before description) to signal project health and security posture. Badge selection based on research of Microsoft flagship and enterprise OSS patterns.

Badge Selection Rationale

Research of Microsoft flagship projects (TypeScript, VS Code, Azure SDK, Playwright, Semantic Kernel) and enterprise OSS projects (Kubernetes, Prometheus, Terraform) found:

  • Badge counts range 3-5, not exhaustive lists
  • No coverage badges at README top (0/5 Microsoft flagships)
  • Security certifications appear first or near-first
  • Default flat style universal (no for-the-badge for status badges)

Proposed Badges (4-badge minimal set)

Position Badge Category Rationale
1 CI Status Build Quality gates, demonstrates automated testing
2 CodeQL Security Active security scanning, GitHub-native
3 OpenSSF Best Practices Certification Enterprise trust signal, already achieved (ID: 11795)
4 License Legal Clarity for enterprise adoption

Badges Not Included (with rationale)

Badge Reason
Pester Tests Redundant - CI badge encompasses test status
Codecov Microsoft flagships do not display coverage at README top
Markdown Lint Not an enterprise evaluation signal
Dependency Review Covered by OpenSSF Best Practices certification
GitHub Release Acceptable addition but adds visual clutter
OpenSSF Scorecard Requires workflow implementation first (see #269)

Implementation

Badge Strip (copy-paste ready)

[![CI Status](https://github.com/microsoft/hve-core/actions/workflows/main.yml/badge.svg)](https://github.com/microsoft/hve-core/actions/workflows/main.yml)
[![CodeQL](https://github.com/microsoft/hve-core/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/microsoft/hve-core/actions/workflows/codeql-analysis.yml)
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11795/badge)](https://www.bestpractices.dev/projects/11795)
[![License](https://img.shields.io/github/license/microsoft/hve-core)](./LICENSE)

Tasks

  • Add badge strip after frontmatter, before description paragraph
  • Remove duplicate OpenSSF badge from Legal section
  • Verify all badge URLs resolve correctly

Acceptance Criteria

  • 4-badge strip appears at top of README content
  • All badges link to their respective sources
  • No broken badge images
  • OpenSSF badge relocated (not duplicated)
  • Default flat style for visual consistency

Related

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions