39
/ 100
Some interest. A stronger README and CI would help.
给 Markdown 文章加语义配图:1. 先根据文章结构,在正文里插入可检查、可修改的插图预渲染 Prompt 标签;2. 再根据这些 Prompt 生成图片,并把图片引用插回原位置
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to D (62).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 3README12pt
Link to a deployed version, docs site, or demo video. Users want to see it running.
- 4README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
45
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README is present.
Licensed under MIT.
Engineering
29
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
No linter or formatter config found.
→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.
No dependency lockfile found (−70 pts).
→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.
No issue or PR templates found (−100 pts).
→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
Test files detected (tests).
Project health
62
No dependency manifest detected at root.
→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.
.gitignore present.
Repository has a description.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 21 / 21Commits (30d / 90d)
- 1Forks
- 0Releases
Community
- 42% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 33Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files7 root entries
- assetsIssue: Build artifacts or local files may be committed (assets/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
- testsGood: Test files detected (tests).
- zu-article-image-skill
- .gitignoreGood: .gitignore present.
- LICENSEGood: Licensed under MIT.
- README.en.mdGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.Good: README has code examples.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- README.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/wwenj/zu-article-image-skill)