0
/ 100
Some interest. A stronger README and CI would help.
A collection of tools for developing and testing CiviCRM.
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 C (76).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add `pull_request:` to the workflow `on:` triggers.
- 4CI/CD14pt
Add a lint step to catch style issues automatically.
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
49
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 documents how to install the project.
README is present.
A license file is present.
Engineering
33
No linter or formatter found.
→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.
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 (phpunit.xml.dist).
CI is configured (.github/workflows/stale.yml).
Lockfile present (composer.lock). Installs are reproducible.
Project health
92
Dependency manifest found (composer.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 97Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 68Watchers
Responsiveness
- 4hMedian issue response
- <1hMedian PR merge time
- 3Open issues
Repository files19 root entries
- .githubGood: CI is configured (.github/workflows/stale.yml).
- .loco
- app
- bin
- nix
- src
- tests
- toolsGood: A license file is present.
- .gitignoreGood: .gitignore present.
- .gitlab-ci.yml
- CHANGELOG.md
- composer.jsonGood: Dependency manifest found (composer.json).
- composer.lockGood: Lockfile present (composer.lock). Installs are reproducible.
- default.nix
- package-lock.json
- package.json
- phars.json
- phpunit.xml.distGood: Test files detected (phpunit.xml.dist).
- README.mdGood: README is present.Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/civicrm/civicrm-buildkit)