docs: Update README - #6
Merged
Merged
Conversation
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update README badges to replace stale individual workflow badges with consolidated CI badges. Also adds
tybadge to reflect the mypy → ty migration.Changes
code_checks.ymlandtests.ymlbadges with consolidatedci.ymlbadges.CI- consolidated workflow statusRuff- linting/formattingty- type checking (replaces mypy)Bandit- security scanningTests- test suite statusChecklist
make lint-check)make lint-typing)make lint-typos)make security-bandit)make security-audit)uv run pre-commit run --all-files)