0

/ 100

GradeF

Getting noticed, but rough fundamentals could turn visitors away.

Higher than 34% of 5,156 graded repos

Overlay for Gentoo Users.

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

See your top fixes
Now
F
48
Potential
C
76

Top fixes

Highest-impact changes first, ranked by point weight

15 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 a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

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

64

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt55

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

→ Add a section showing how to install dependencies.

README12pt70

README is present.

License6pt100

Licensed under GPL-2.0.

Engineering

30

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 linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Reproducibility6pt12

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt57

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • 2h
    Median issue response
  • 2h
    Median PR merge time
  • 109
    Open issues
Repository files91 root entries
  • .github
    Good: CI is configured (.github/workflows/nvchecker.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • acct-group
  • acct-user
  • app-admin
  • app-alternatives
  • app-arch
  • app-backup
  • app-containers
  • app-crypt
  • app-dicts
  • app-doc
  • app-editors
  • app-emulation
  • app-i18n
  • app-misc
  • app-office
  • app-pda
  • app-shells
  • app-text
  • app-vim
  • dev-cpp
  • dev-db
  • dev-debug
  • dev-embedded
  • dev-go
  • dev-java
  • dev-lang
  • dev-libs
  • dev-python
  • dev-ruby
  • dev-util
  • dev-vcs
  • games-action
  • games-arcade
  • games-emulation
  • games-fps
  • games-misc
  • games-roguelike
  • games-server
  • games-strategy
  • gnome-extra
  • gui-apps
  • gui-libs
  • kde-misc
  • licenses
  • mate-base
  • media-fonts
  • media-gfx
  • media-libs
  • media-plugins
  • media-sound
  • media-video
  • metadata
  • net-analyzer
  • net-dns
  • net-im
  • net-libs
  • net-misc
  • net-p2p
  • net-print
  • net-proxy
  • net-vpn
  • net-wireless
  • profiles
  • sci-chemistry
  • sci-electronics
  • sci-ml
  • scripts
  • sec-policy
  • sys-apps
  • sys-boot
  • sys-fs
  • sys-kernel
  • sys-libs
  • sys-power
  • virtual
  • www-apps
  • www-client
  • www-servers
  • x11-libs
  • x11-misc
  • x11-terms
  • x11-themes
  • x11-wm
  • .gitignore
    Good: .gitignore present.
  • AUTHORS
  • COPYING
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    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.
    Good: README documents how to run the project.
  • repo.xml
  • skel.ChangeLog
  • skel.metadata.xml
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/microcai/gentoo-zh)](https://www.repo-grade.com/report/microcai/gentoo-zh)

More graded Shell repos