civicrm/civicrm-buildkit

0

/ 100

Documentation49
Engineering33
Health92
Shell681d ago
Grade a repo

Some interest. A stronger README and CI would help.

A collection of tools for developing and testing CiviCRM.

Documentation

49

Contributing guide5pt0

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.

Install and run instructions9pt45

README documents how to install the project.

README12pt48

README is present.

License6pt100

A license file is present.

Engineering

33

Linting and formatting5pt0

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.

Issue and PR templates6pt0

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.

Tests18pt35

Test files detected (phpunit.xml.dist).

CI/CD14pt40

CI is configured (.github/workflows/stale.yml).

Reproducibility6pt70

Lockfile present (composer.lock). Installs are reproducible.

Project health

92

Dependency manifest6pt75

Dependency manifest found (composer.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 97
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 68
    Watchers

Responsiveness

  • 4h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/stale.yml).
  • .loco
  • app
  • bin
  • nix
  • src
  • tests
  • tools
    Good: A license file is present.
  • .gitignore
    Good: .gitignore present.
  • .gitlab-ci.yml
  • CHANGELOG.md
  • composer.json
    Good: Dependency manifest found (composer.json).
  • composer.lock
    Good: Lockfile present (composer.lock). Installs are reproducible.
  • default.nix
  • package-lock.json
  • package.json
  • phars.json
  • phpunit.xml.dist
    Good: Test files detected (phpunit.xml.dist).
  • README.md
    Good: 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.