midorikami/kamitoolkit
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

Higher than 23% of 5,156 graded repos

C# Wrapper for FFXIV's Native UI AddonToolKit

Documentation19
Engineering22
Health94
C#35MIT1mo 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 lift this repo to C (73).

See your top fixes
Now
F
34
Potential
C
73

Top fixes

Highest-impact changes first, ranked by point weight

23 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

19

README12pt0

README is present.

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

License6pt100

Licensed under MIT.

Engineering

22

Tests18pt0

No tests detected anywhere in the repository.

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

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/publish-nuget.yml).

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (KamiToolKit.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 30
    Forks
  • 1
    Releaseslatest 3mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 35
    Watchers

Responsiveness

  • 17h
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files26 root entries
  • .github
    Good: CI is configured (.github/workflows/publish-nuget.yml).
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/.idea.KamiToolKit) (−40 pts).Fix: Remove them and add to .gitignore.
  • Addons
  • Assets
  • BaseTypes
  • Classes
  • ContextMenu
  • Controllers
  • Enums
  • Extensions
  • Interfaces
  • Internal
  • MapOverlay
  • Nodes
  • Timelines
  • UiOverlay
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • Experimental.cs
  • GlobalUsings.cs
  • KamiToolKit.csproj
    Good: Dependency manifest found (KamiToolKit.csproj).
  • KamiToolKit.csproj.DotSettings
  • KamiToolKit.sln
  • KamiToolKitLibrary.cs
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
    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.
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/midorikami/kamitoolkit)](https://www.repo-grade.com/report/midorikami/kamitoolkit)

More graded C# repos