reekta92/clin-rs
Grade a repo

0

/ 100

GradeB

Good shape overall. A few tweaks would push it into the top tier.

Top 32% of 5,156 graded repos

TUI note management app inspired by Obsidian

Documentation95
Engineering62
Health98
Rust310GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

8 to address
  1. 1
    Tests18pt

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

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  4. 4
    Dependency manifest6pt

    Add `documentation = "https://docs.rs/<crate>"` to [package] so users can find the API docs.

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

95

Contributing guide5pt86

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

62

Tests18pt0

No tests detected anywhere in the repository.

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

Reproducibility6pt90

Lockfile present (Cargo.lock). Installs are reproducible.

CI/CD14pt100

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

Linting and formatting5pt100

Rust linting configured (.editorconfig, cargo clippy in CI, cargo fmt in CI).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

98

Dependency manifest6pt95

Dependency manifest found (Cargo.toml).

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)
  • 7
    Forks
  • 24
    Releaseslatest 1mo ago

Community

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

Responsiveness

  • 3h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • assets
  • docs
  • examples
  • src
  • .editorconfig
    Good: Rust linting configured (.editorconfig, cargo clippy in CI, cargo fmt in CI).
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • cliff.toml
  • clin.ico
  • clippy.toml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • 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.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    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.
  • deny.toml
  • flake.nix
  • LICENSE
    Good: Licensed under GPL-3.0.
  • PKGBUILD
  • 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.
  • ROADMAP.md
  • rustfmt.toml
  • SECURITY.md
    Good: Security policy present.
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/reekta92/clin-rs)](https://www.repo-grade.com/report/reekta92/clin-rs)

More graded Rust repos