nopsolutions/nopcommerce: Grade C (76/100)

nopsolutions/nopcommerce

/ 100

Documentation68

Engineering74

Health94

C#10,087Other5d ago

Grade a repo

Popular and well-maintained. A little polish away from elite status.

ASP.NET Core eCommerce software. nopCommerce is a free and open-source shopping cart.

Documentation

2 checks need work

Install and run instructions9pt

README documents how to install the project.

Contributing guide5pt

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt

README is present.

License6pt

100

Licensed under Other.

Engineering

1 checks need work

Issue and PR templates6pt

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.

Tests18pt

Test files detected (src/Tests).

Reproducibility6pt

Lockfile present (src/Presentation/Nop.Web/package-lock.json). Installs are reproducible.

CI/CD14pt

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

Linting and formatting5pt

100

.NET formatting configured (.editorconfig).

Project health

1 checks need work

Housekeeping3pt

.gitignore present.

Dependency manifest6pt

100

Dependency manifest found (src/Build/src/ClearPluginAssemblies.sln).

Repository metadata5pt

100

Repository has a description.

Activity5pt

100

Actively maintained (pushed within the last month).

Repository files18 root entries

.github
Good: CI is configured (.github/workflows/dotnet.yml).
src
Good: Test files detected (src/Tests).
Good: Lockfile present (src/Presentation/Nop.Web/package-lock.json). Installs are reproducible.
Good: Dependency manifest found (src/Build/src/ClearPluginAssemblies.sln).
Issue: Build artifacts or local files may be committed (src/Presentation/Nop.Web/wwwroot/lib_npm/datatables.net-buttons-bs4/node_modules/datatables.net-bs4) (−40 pts).Fix: Remove them and add to .gitignore.
upgradescripts
.dockerignore
.editorconfig
Good: .NET formatting configured (.editorconfig).
.gitattributes
.gitignore
Good: .gitignore present.
CODE_OF_CONDUCT.md
Good: Code of conduct present.
CONTRIBUTING.md
Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
docker-compose.yml
Dockerfile
Good: Environment pinned via Dockerfile.
global.json
ISSUE_TEMPLATE.md
LICENSE.md
Good: Licensed under Other.
mysql-docker-compose.yml
postgresql-docker-compose.yml
README.md
Good: README is present.
Good: README is well structured with multiple sections.
Good: README includes screenshots or visuals. Great for first impressions.
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.
SECURITY.md
Good: Security policy present.