file-new-project/eartrumpet

0

/ 100

Documentation85
Engineering29
Health100
C#11,085Other10d ago
Grade a repo

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

EarTrumpet - Volume Control for Windows

Documentation

85

Contributing guide5pt61

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

29

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Linting and formatting5pt0

No .NET formatter configured.

→ Add an .editorconfig to define C# formatting rules and run `dotnet format` in CI.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

CI/CD14pt57

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (EarTrumpet.vs15.sln).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files20 root entries
  • .chocolatey
    Good: Licensed under Other.
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Issue or PR templates present.
  • EarTrumpet
  • EarTrumpet.ColorTool
  • EarTrumpet.Package
  • Graphics
  • Packaging
  • Resources
  • .azure-pipelines.yml
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
  • COMPILING.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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).
    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.
  • crowdin.yml
  • EarTrumpet.vs15.sln
    Good: Dependency manifest found (EarTrumpet.vs15.sln).
  • GitVersion.yml
  • LICENSE
  • PRIVACY.md
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.