dotnet/aspnetcore.docs

0

/ 100

Documentation50
Engineering73
Health100
C#13,113CC-BY-4.05d ago
Grade a repo

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

Documentation for ASP.NET Core

Documentation

50

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt48

README is present.

Contributing guide5pt85

Contributing guide is detailed and thorough.

License6pt100

Licensed under CC-BY-4.0.

Engineering

73

CI/CD14pt40

CI is configured (.github/workflows/check-for-build-warnings.yml).

Tests18pt80

Test files detected (aspnetcore/client-side/spa-services/sample/SpaServicesSampleApp/ClientApp/app/components/counter/counter.component.spec.ts).

Reproducibility6pt80

Lockfile present (aspnetcore/data/ef-rp/intro/samples/cu/wwwroot/lib/bootstrap/Gemfile.lock). Installs are reproducible.

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (aspnetcore/client-side/libman/samples/LibManSample/LibManSample.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/check-for-build-warnings.yml).
    Good: Issue or PR templates present.
  • .vscode
  • aspnetcore
    Good: Test files detected (aspnetcore/client-side/spa-services/sample/SpaServicesSampleApp/ClientApp/app/components/counter/counter.component.spec.ts).
    Good: Lockfile present (aspnetcore/data/ef-rp/intro/samples/cu/wwwroot/lib/bootstrap/Gemfile.lock). Installs are reproducible.
    Good: Environment pinned via aspnetcore/host-and-deploy/docker/visual-studio-tools-for-docker/samples/2.0/HelloDockerTools/Dockerfile.
    Good: Security policy present.
    Good: Dependency manifest found (aspnetcore/client-side/libman/samples/LibManSample/LibManSample.csproj).
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.json
  • .openpublishing.publish.config.json
  • .openpublishing.redirection.json
  • .repoman.yml
  • .whatsnew.json
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • cspell.json
  • LICENSE
    Good: Licensed under CC-BY-4.0.
  • LICENSE-CODE
  • quest-config.json
  • README.md
    Good: README is present.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
  • ThirdPartyNotices