docs: add desloppify scorecard and score badge#27
Conversation
📝 WalkthroughWalkthroughREADME badges updated to include a new “desloppify score” shields.io badge linking to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 8✅ Passed checks (8 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Auto-Merge Gate Check — BlockedPR labeled Failed Gates
How to unblock
Permanent block
Auto-Merge Gate Check — 2026-04-22T14:27:57.886Z |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 250: The <img> tag referencing "scorecard.png" in README.md is missing an
alt attribute; update the HTML image tag to include a descriptive alt text
(e.g., alt="project scorecard showing X metrics") so the element for
"scorecard.png" is accessible and satisfies MD045; locate the img tag and add an
appropriate alt string that concisely describes the image content.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 88bf2962-35b5-4816-82c2-ef58724e505e
⛔ Files ignored due to path filters (1)
scorecard.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
samtuckerdavis
force-pushed
the
feat/desloppify-scorecard
branch
from
cc0b41b to
938f0cc
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 1: The README badge references a relative scorecard.png which breaks on
PyPI; update the badge URL in the README markdown line (the badge link that
currently points to scorecard.png) to use the full GitHub URL
(https://github.com/Open-Paws/desloppify/blob/main/scorecard.png) so the image
resolves outside the repo and renders correctly on PyPI.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 78cbb4e6-987d-4209-b9fc-3eba1148a1b1
⛔ Files ignored due to path filters (1)
scorecard.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md
| @@ -1,4 +1,4 @@ | |||
| [](https://pypi.org/project/desloppify/) [](LICENSE) [](https://www.python.org/downloads/) [](https://github.com/Open-Paws/desloppify/commits/main) | |||
| [](https://pypi.org/project/desloppify/) [](LICENSE) [](https://www.python.org/downloads/) [](https://github.com/Open-Paws/desloppify/commits/main) [](scorecard.png) | |||
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Check if scorecard.png is included in the package distribution
# Check if setup.py or pyproject.toml includes scorecard.png in package_data or data_files
fd -e py -e toml 'setup|pyproject' --exec grep -l 'scorecard.png' {}Repository: Open-Paws/desloppify
Length of output: 46
🏁 Script executed:
# Check if scorecard.png exists in the repository
fd scorecard.pngRepository: Open-Paws/desloppify
Length of output: 46
🏁 Script executed:
# Examine the package configuration to understand how assets are handled
git ls-files | head -20Repository: Open-Paws/desloppify
Length of output: 722
🏁 Script executed:
# Check pyproject.toml and setup.py content if they exist
fd -e toml -e py 'setup|pyproject' -x cat {}Repository: Open-Paws/desloppify
Length of output: 14847
🏁 Script executed:
# Explicitly check for scorecard.png existence with verbose output
fd scorecard.png -vRepository: Open-Paws/desloppify
Length of output: 294
🏁 Script executed:
# Also check with find as backup
find . -name "scorecard.png" -type fRepository: Open-Paws/desloppify
Length of output: 102
🏁 Script executed:
# Check the README to see if score metrics are explained in the new scorecard section
sed -n '172,180p' README.mdRepository: Open-Paws/desloppify
Length of output: 497
🏁 Script executed:
# Also check what the badge currently links to in line 1
sed -n '1p' README.mdRepository: Open-Paws/desloppify
Length of output: 567
Fix badge link for PyPI distribution.
The badge links to a relative scorecard.png, which breaks when PyPI renders the README—the file isn't included in the package distribution (absent from pyproject.toml's package-data). Use the full GitHub URL instead: https://github.com/Open-Paws/desloppify/blob/main/scorecard.png.
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 1-1: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 1, The README badge references a relative scorecard.png
which breaks on PyPI; update the badge URL in the README markdown line (the
badge link that currently points to scorecard.png) to use the full GitHub URL
(https://github.com/Open-Paws/desloppify/blob/main/scorecard.png) so the image
resolves outside the repo and renders correctly on PyPI.
1 participant
Adds the current desloppify mechanical scan score as a badge and embeds the full scorecard image. Score: 24.7/100. Scorecard tracked as
scorecard.pngin repo root.\n\nNote: the strict score is 24.7 because desloppify scanning itself triggers self-referential wontfix items. The objective/verified score is 98.8.Summary by CodeRabbit