Skip to content

docs: add desloppify scorecard and score badge #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samtuckerdavis merged 1 commit into from
Apr 22, 2026
Merged

docs: add desloppify scorecard and score badge #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![PyPI version](https://img.shields.io/pypi/v/desloppify)](https://pypi.org/project/desloppify/) [![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/) [![Last commit](https://img.shields.io/github/last-commit/Open-Paws/desloppify)](https://github.com/Open-Paws/desloppify/commits/main)
[![PyPI version](https://img.shields.io/pypi/v/desloppify)](https://pypi.org/project/desloppify/) [![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/) [![Last commit](https://img.shields.io/github/last-commit/Open-Paws/desloppify)](https://github.com/Open-Paws/desloppify/commits/main) [![desloppify score](https://img.shields.io/badge/desloppify-24.7%2F100-red)](scorecard.png)
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 22, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 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.png

Repository: Open-Paws/desloppify

Length of output: 46

🏁 Script executed:

# Examine the package configuration to understand how assets are handled
git ls-files | head -20

Repository: 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 -v

Repository: Open-Paws/desloppify

Length of output: 294

🏁 Script executed:

# Also check with find as backup
find . -name "scorecard.png" -type f

Repository: 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.md

Repository: Open-Paws/desloppify

Length of output: 497

🏁 Script executed:

# Also check what the badge currently links to in line 1
sed -n '1p' README.md

Repository: 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.


# Desloppify — Open Paws Fork

Expand Down Expand Up @@ -169,6 +169,10 @@ git merge upstream/main

</details>

## Code Quality

<img src="scorecard.png" alt="Desloppify scorecard showing strict score 24.7/100 and objective/verified score 98.8" width="100%">

## Contributing

Issues and pull requests go to [github.com/Open-Paws/desloppify](https://github.com/Open-Paws/desloppify).
Expand Down
Binary file added scorecard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading