Skip to content

Reorganize README badges and add coverage/community badges#146

Merged
bernardladenthin merged 4 commits into
mainfrom
claude/audit-readme-badges-PdXp0
May 16, 2026
Merged

Reorganize README badges and add coverage/community badges#146
bernardladenthin merged 4 commits into
mainfrom
claude/audit-readme-badges-PdXp0

Conversation

@bernardladenthin

Copy link
Copy Markdown
Owner

Summary

Reorganized the README.md badges into logical sections for better readability and added new badges for code coverage and community standards.

Changes

  • Reorganized badges into four clearly labeled sections:

    • Build: Java version, llama.cpp version, CI workflow status (Publish and CodeQL)
    • Coverage: Coveralls and Codecov coverage badges
    • Package: Maven Central and Snapshot repository links
    • License: Apache 2.0 license badge
    • Community: OpenSSF Best Practices badge
  • Added new badges:

    • Publish workflow status badge linking to GitHub Actions
    • CodeQL workflow status badge linking to GitHub Actions
    • Coveralls coverage badge
    • Codecov coverage badge
    • Apache 2.0 license badge
    • OpenSSF Best Practices badge
  • Improved formatting: Added line breaks and consistent spacing between badge sections for better visual organization

Details

The badges are now grouped by purpose, making it easier for users to quickly find relevant information about the project's build status, code quality, distribution channels, and community standards. All badges link to their respective services or workflows.

https://claude.ai/code/session_01XUpsiwWio7dX379whH838C

claude added 4 commits May 16, 2026 13:09
- java-llama.cpp: add Publish CI, CodeQL, Coveralls, Codecov, License badges; add section comments
- streambuffer: remove dead Travis CI and LGTM (x2) badges; fix Maven Central URL to shields.io; add Java version, Publish CI, CodeQL badges; add section comments; reorder by category
- llamacpp-ai-index-maven-plugin: add full badge set (Java, Publish CI, CodeQL, Coveralls, Codecov, Maven Central, Snapshot, License)
- BitcoinAddressFinder: add CodeQL badge to Build & Environment section

https://claude.ai/code/session_01XUpsiwWio7dX379whH838C
@claude

claude Bot commented May 16, 2026

Copy link
Copy Markdown

Review Summary

This PR reorganizes README.md badges into logical sections and adds new service badges. Overall, this is a documentation improvement with good organization.

Strengths:

  • Logical grouping by purpose (Build, Coverage, Package, License, Community)
  • Improved readability with section headers and spacing
  • New badges provide valuable project metadata
  • All links are HTTPS and point to reputable services

Verification Needed:

  1. Confirm Coveralls and Codecov services are configured in CI/CD (badges will show no data if unconfigured)
  2. Verify OpenSSF Best Practices ID 12862 is correct for this repository
  3. Confirm new Publish and CodeQL workflow badges reference existing, stable workflows

Minor Notes:

  • LICENSE link: using LICENSE instead of ./LICENSE would be more idiomatic for GitHub
  • Consider documenting badge meanings in CONTRIBUTING.md

Security: No concerns - all external links are to trusted services and use HTTPS.

@bernardladenthin bernardladenthin merged commit a99e4c3 into main May 16, 2026
4 of 27 checks passed
@bernardladenthin bernardladenthin deleted the claude/audit-readme-badges-PdXp0 branch May 16, 2026 19:51
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