ppy/osu

0

/ 100

Documentation92
Engineering78
Health94
C#18,543MIT6d ago
Grade a repo

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

rhythm is just a *click* away!

Documentation

92

Contributing guide5pt67

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

78

Reproducibility6pt12

No dependency lockfile found (−70 pts).

→ Enable and commit packages.lock.json so NuGet restores are repeatable.

Tests18pt80

Test files detected (osu.Game.Benchmarks/BenchmarkTest.cs).

CI/CD14pt85

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

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (osu.sln).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files60 root entries
  • .config
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for nuget.
    Good: Issue or PR templates present.
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/.gitignore) (−40 pts).Fix: Remove them and add to .gitignore.
  • .run
  • .vscode
  • assets
  • CodeAnalysis
  • osu.Android
  • osu.Desktop
  • osu.Game
  • osu.Game.Benchmarks
    Good: Test files detected (osu.Game.Benchmarks/BenchmarkTest.cs).
  • osu.Game.Rulesets.Catch
  • osu.Game.Rulesets.Catch.Tests
  • osu.Game.Rulesets.Catch.Tests.Android
  • osu.Game.Rulesets.Catch.Tests.iOS
  • osu.Game.Rulesets.Mania
  • osu.Game.Rulesets.Mania.Tests
  • osu.Game.Rulesets.Mania.Tests.Android
  • osu.Game.Rulesets.Mania.Tests.iOS
  • osu.Game.Rulesets.Osu
  • osu.Game.Rulesets.Osu.Tests
  • osu.Game.Rulesets.Osu.Tests.Android
  • osu.Game.Rulesets.Osu.Tests.iOS
  • osu.Game.Rulesets.Taiko
  • osu.Game.Rulesets.Taiko.Tests
  • osu.Game.Rulesets.Taiko.Tests.Android
  • osu.Game.Rulesets.Taiko.Tests.iOS
  • osu.Game.Tests
  • osu.Game.Tests.Android
  • osu.Game.Tests.iOS
  • osu.Game.Tournament
  • osu.Game.Tournament.Tests
  • osu.iOS
  • Templates
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • app.manifest
  • 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).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Directory.Build.props
  • FodyWeavers.xml
  • global.json
  • InspectCode.ps1
  • InspectCode.sh
  • LICENCE
    Good: Licensed under MIT.
  • osu.Android.props
  • osu.Android.slnf
  • osu.Desktop.slnf
  • osu.iOS.props
  • osu.iOS.slnf
  • osu.licenseheader
  • osu.sln
    Good: Dependency manifest found (osu.sln).
  • osu.sln.DotSettings
  • osu.TestProject.props
  • 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.
  • UseLocalFramework.ps1
  • UseLocalFramework.sh
  • UseLocalResources.ps1
  • UseLocalResources.sh