dotnet/orleans

0

/ 100

Documentation92
Engineering74
Health100
C#10,791MIT6d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Cloud Native application framework for .NET

Documentation

92

Contributing guide5pt64

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

74

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

Reproducibility6pt82

Lockfile present (src/Dashboard/Orleans.Dashboard.App/package-lock.json). Installs are reproducible.

CI/CD14pt85

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

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (playground/ActivationRebalancing/ActivationRebalancing.AppHost/ActivationRebalancing.AppHost.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files37 root entries
  • .azure
  • .azuredevops
  • .config
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for dotnet-sdk.
  • .vscode
  • assets
  • playground
    Good: Dependency manifest found (playground/ActivationRebalancing/ActivationRebalancing.AppHost/ActivationRebalancing.AppHost.csproj).
  • samples
  • sign
  • src
    Good: Lockfile present (src/Dashboard/Orleans.Dashboard.App/package-lock.json). Installs are reproducible.
  • test
    Good: Test files detected (test).
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • aspire.config.json
  • Build.cmd
  • build.ps1
  • CODE-OF-CONDUCT.md
  • common.ps1
  • 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.
    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.
    Good: Contributing guide includes code examples.
  • Directory.Build.props
  • Directory.Build.targets
  • Directory.Packages.props
  • distributed-tests.yml
  • es-metadata.yml
  • global.json
  • LICENSE
    Good: Licensed under MIT.
  • NuGet.Config
  • Orleans.slnx
  • Parallel-Tests.ps1
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • spelling.dic
  • SUPPORT.md
  • Test.cmd
  • TestAll.cmd