shopware/administration

0

/ 100

Documentation30
Engineering48
Health84
JavaScript40MIT3d ago
Grade a repo

Some interest. A stronger README and CI would help.

Documentation

30

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

README12pt30

README is present.

License6pt100

Licensed under MIT.

Engineering

48

CI/CD14pt0

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.

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.

Reproducibility6pt70

Lockfile present (Resources/app/administration/eslint-rules/core-rules/package-lock.json). Installs are reproducible.

Tests18pt80

Test files detected (Resources/app/administration/build/vite-plugins/asset-css-postprocess-plugin/index.spec.js).

Linting and formatting5pt100

PHP linting configured (Resources/app/administration/.prettierrc.js).

Project health

84

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt100

Dependency manifest found (composer.json).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files17 root entries
  • Command
  • Controller
  • Dashboard
  • DependencyInjection
  • Events
  • Framework
  • Migration
  • Notification
  • Resources
    Good: Test files detected (Resources/app/administration/build/vite-plugins/asset-css-postprocess-plugin/index.spec.js).
    Good: PHP linting configured (Resources/app/administration/.prettierrc.js).
    Good: Lockfile present (Resources/app/administration/eslint-rules/core-rules/package-lock.json). Installs are reproducible.
    Good: .gitignore present.
  • Service
  • Snippet
  • System
  • .gitattributes
  • Administration.php
  • composer.json
    Good: Dependency manifest found (composer.json).
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.