shopware/storefront
Grade a repo

55

/ 100

GradeF

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

Higher than 40% of 5,156 graded repos
Documentation52
Engineering48
Health78
JavaScript67MIT1mo ago

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 (78).

See your top fixes
Now
F
55
Potential
C
78

Top fixes

Highest-impact changes first, ranked by point weight

15 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/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.

  3. 3
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  4. 4
    README12pt

    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.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

52

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.

README12pt55

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/package-lock.json). Installs are reproducible.

Tests18pt80

Test files detected (Resources/app/administration/src/core/service/api/theme.api.service.spec.js).

Linting and formatting5pt100

PHP linting configured (Resources/app/administration/eslint.config.mjs).

Project health

78

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.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (composer.json).

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 37
    Forks
  • 0
    Releases

Community

  • 25% - Weak
    Community health
  • -
    authors own >50% of commits
  • 67
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files19 root entries
  • Checkout
  • Controller
  • DependencyInjection
  • Event
  • Framework
  • Mcp
  • Migration
  • Page
  • Pagelet
  • Resources
    Good: Test files detected (Resources/app/administration/src/core/service/api/theme.api.service.spec.js).
    Good: PHP linting configured (Resources/app/administration/eslint.config.mjs).
    Good: Lockfile present (Resources/app/administration/package-lock.json). Installs are reproducible.
    Issue: Build artifacts or local files may be committed (Resources/app/storefront/vendor/tiny-slider/src/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • Storybook
  • System
  • Test
  • Theme
  • .gitignore
    Good: .gitignore present.
  • composer.json
    Good: Dependency manifest found (composer.json).
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
    Good: README has code examples.
    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.
  • Storefront.php
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/shopware/storefront)](https://www.repo-grade.com/report/shopware/storefront)

More graded JavaScript repos