-
Notifications
You must be signed in to change notification settings - Fork 128
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
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-badgefor 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)
[](https://github.com/microsoft/hve-core/actions/workflows/main.yml)
[](https://github.com/microsoft/hve-core/actions/workflows/codeql-analysis.yml)
[](https://www.bestpractices.dev/projects/11795)
[](./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
- Research:
.copilot-tracking/research/20260123-issue-258-badge-strategy-research.md - Follow-up: Implement OpenSSF Scorecard workflow and badge #269 (OpenSSF Scorecard workflow implementation)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request