albertofem/rsync-lib

0

/ 100

Documentation76
Engineering58
Health79
PHP89MIT1y ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

A simple PHP rsync wrapper library

Documentation

76

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.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

58

Linting and formatting5pt0

No PHP linter or static analysis tool configured.

→ Add PHP_CodeSniffer (phpcs.xml) for style or PHPStan (phpstan.neon) for static analysis. Run either in CI.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit composer.lock so Composer installs are repeatable.

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.

Tests18pt80

Test files detected (phpunit.xml.dist).

CI/CD14pt100

CI is configured (.travis.yml).

Project health

79

Activity5pt20

No pushes in over a year (−80 pts).

→ A recent commit signals the project is alive and worth contributing to.

Dependency manifest6pt100

Dependency manifest found (composer.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files9 root entries
  • scripts
  • src
  • tests
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • composer.json
    Good: Dependency manifest found (composer.json).
  • LICENSE
    Good: Licensed under MIT.
  • phpunit.xml.dist
    Good: Test files detected (phpunit.xml.dist).
  • README.md
    Good: 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.
    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.