95
/ 100
A top-tier open source project. Docs, tests, and CI are all in excellent shape.
A cat(1) clone with wings.
Outstanding. A score of 95/100 puts this repo in a very small tier of truly well-engineered projects.
Top 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.
- 2Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
- 3Contributing guide5pt
Describe your linting/formatting rules and how to run them.
- 4Contributing guide5pt
Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
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
95
Contributing guide is detailed and thorough.
README documents how to install the project.
README is present.
Licensed under Apache-2.0.
Engineering
93
Test files detected (tests).
CI is configured (.github/workflows/CICD.yml).
Linter or formatter configured (rustfmt.toml).
Lockfile present (Cargo.lock). Installs are reproducible.
Issue or PR templates present.
Project health
100
Dependency manifest found (Cargo.toml).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 7 / 60Commits (30d / 90d)
- 1,572Forks
- 43Releaseslatest 7y ago
Community
- 85% - GoodCommunity health
- 3 bus factorauthors own >50% of commits
- 59,401Watchers
Responsiveness
- 9hMedian issue response
- 3hMedian PR merge time
- 387Open issues
Repository files24 root entries
- .cargo
- .githubGood: CI is configured (.github/workflows/CICD.yml).Good: Dependabot covers 3 ecosystems (cargo, gitsubmodule, github-actions). Dependencies stay current.Good: Issue or PR templates present.
- assets
- build
- diagnostics
- doc
- examples
- src
- testsGood: Licensed under Apache-2.0.Good: Test files detected (tests).Good: Environment pinned via tests/syntax-tests/highlighted/Dockerfile.
- .envrc
- .gitignoreGood: .gitignore present.
- .gitmodules
- Cargo.lockGood: Lockfile present (Cargo.lock). Installs are reproducible.
- Cargo.tomlGood: Dependency manifest found (Cargo.toml).
- CHANGELOG.md
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.Good: Contributing guide includes setup/install instructions.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- flake.lock
- flake.nix
- LICENSE-APACHE
- LICENSE-MIT
- NOTICE
- README.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.Good: README links to a live demo or deployed app.Good: README includes status badges.Good: README documents how to install the project.Good: README documents how to run the project.
- rustfmt.tomlGood: Linter or formatter configured (rustfmt.toml).
- SECURITY.mdGood: Security policy present.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/sharkdp/bat)