dodyg/practical-aspnetcore

0

/ 100

Documentation53
Engineering49
Health100
C#10,383MIT9d ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

Practical samples of ASP.NET Core 11, 10, 9, 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.

Documentation

53

README12pt35

README is present.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

Contributing guide5pt52

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.

License6pt100

Licensed under MIT.

Engineering

49

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.

Tests18pt80

Test files detected (projects/testing/nunit-1/tests).

Reproducibility6pt80

Lockfile present (projects/signalr/signalr-1/Client/package-lock.json). Installs are reproducible.

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (projects/application-environment/application-environment.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files19 root entries
  • .github
  • .vscode
  • exercises
  • projects
    Good: Test files detected (projects/testing/nunit-1/tests).
    Good: Lockfile present (projects/signalr/signalr-1/Client/package-lock.json). Installs are reproducible.
    Good: Environment pinned via projects/logging/logging-Loki/docker-compose.yml.
    Good: Dependency manifest found (projects/application-environment/application-environment.csproj).
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • build-log-after-prune.txt
  • build-log.txt
  • 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.
  • global.json
  • LICENSE
    Good: Licensed under MIT.
  • MIGRATION-PLAN.md
  • OUT-OF-DATE.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Good: README documents how to run the project.
  • skills-checklist.md
  • STRUCTURE.md