0
/ 100
Lots of room to improve. Start with a README and CI.
The Darwin Kernel (mirror)
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 (66).
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
Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
- 4README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
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
59
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.
README documents how to install the project.
Licensed under Other.
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 the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
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 (iokit/Tests).
Project health
43
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.
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
Repository has a description.
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 0Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files22 root entries
- bsd
- config
- EXTERNAL_HEADERS
- iokitGood: Test files detected (iokit/Tests).
- libkdd
- libkern
- libsa
- libsyscall
- makedefs
- osfmk
- pexpert
- san
- security
- SETUP
- tools
- .clang-format
- .gitignoreGood: .gitignore present.
- .upstream_base_commits
- APPLE_LICENSE
- LICENSEGood: Licensed under Other.
- Makefile
- README.mdGood: README is present.Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.Good: README links to a live demo or deployed app.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.Good: README documents how to install the project.Good: README documents how to run the project.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/zhang-hongjie/darwin-xnu)