Skip to content

docs: Update README - #6

Merged
awinml merged 1 commit into
mainfrom
add_readme_badges
May 26, 2026
Merged

docs: Update README#6
awinml merged 1 commit into
mainfrom
add_readme_badges

Conversation

@awinml

@awinml awinml commented May 26, 2026

Copy link
Copy Markdown
Member

Summary

Update README badges to replace stale individual workflow badges with consolidated CI badges. Also adds ty badge to reflect the mypy → ty migration.

Changes

  • README.md: Replaced stale code_checks.yml and tests.yml badges with consolidated ci.yml badges.
    • CI - consolidated workflow status
    • Ruff - linting/formatting
    • ty - type checking (replaces mypy)
    • Bandit - security scanning
    • Tests - test suite status

Checklist

  • Code follows project style (make lint-check)
  • Type annotations pass (make lint-typing)
  • No typos (make lint-typos)
  • No new security issues (make security-bandit)
  • Dependency vulnerabilities checked (make security-audit)
  • Pre-commit hooks pass (uv run pre-commit run --all-files)

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the badges in the README.md file to point to the consolidated ci.yml workflow. The reviewer pointed out that because Shields.io's GitHub Actions status badge does not support filtering by individual jobs, all of the newly added badges (Ruff, ty, Bandit, Tests) will display as failing if any single job fails. It is recommended to keep only the consolidated CI badge.

Comment thread README.md
@awinml
awinml merged commit e4f6708 into main May 26, 2026
5 checks passed
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.

1 participant