avenreal/tuis
Grade a repo

0

/ 100

GradeF

The fundamentals need work — start with test coverage and the README.

Higher than 15% of 5,156 graded repos
Documentation8
Engineering11
Health74
C#15mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would add 36 points.

See your top fixes
Now
F
22
Potential
F
58

Top fixes

Highest-impact changes first, ranked by point weight

25 to address
  1. 1
    Tests18pt

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

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  4. 4
    CI/CD14pt

    Add a lint step to catch style issues automatically.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

8

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt20

README is present.

Engineering

11

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.

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.

CI/CD14pt40

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

Project health

74

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Activity5pt60

Last pushed 3-6 months ago (−40 pts). A push within 90 days earns 80 pts; within 30 days earns 100 pts.

→ A recent commit keeps the project looking alive to visitors and contributors.

Dependency manifest6pt100

Dependency manifest found (TUIS.csproj).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • 14% - Weak
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 1
    Watchers

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/static.yml).
  • Components
  • docs
  • documentation
  • Images
  • Systems
  • .gitignore
    Good: .gitignore present.
  • docfx.json
  • DynamicTerminal.cs
  • index.md
  • Program.cs
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • Terminal.cs
  • toc.yml
  • TUIS.csproj
    Good: Dependency manifest found (TUIS.csproj).
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/avenreal/tuis)](https://www.repo-grade.com/report/avenreal/tuis)

More graded C# repos