pinnacle-comp/pinnacle
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 20% of 5,156 graded repos

A Smithay-based Wayland compositor, inspired by AwesomeWM and configured in Lua or Rust

Documentation76
Engineering88
Health95
Rust608GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

14 to address
  1. 1
    CI/CD14pt

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

  2. 2
    CI/CD14pt

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

  3. 3
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  4. 4
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

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

76

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt80

Contributing guide is detailed and thorough.

README12pt85

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

88

Reproducibility6pt70

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

CI/CD14pt72

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

Tests18pt100

Test files detected (tests).

Linting and formatting5pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

95

Dependency manifest6pt85

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)
  • 25
    Forks
  • 10
    Releaseslatest 6mo ago

Community

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

Responsiveness

  • 25d 7h
    Median issue response
  • <1h
    Median PR merge time
  • 37
    Open issues
Repository files28 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.pinnacle.yml).
    Good: Issue or PR templates present.
  • api
  • assets
  • nix
  • pinnacle-api-defs
  • proptest-regressions
  • resources
  • snowcap
  • src
  • tests
    Good: Test files detected (tests).
  • wiki
  • wlcs_pinnacle
  • .gitignore
    Good: .gitignore present.
  • build.rs
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • clippy.toml
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    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.
    Good: Contributing guide includes code examples.
  • flake.lock
  • flake.nix
  • justfile
  • LICENSE
    Good: Licensed under GPL-3.0.
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • release_checklist.md
  • rustfmt.toml
    Good: Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).
  • taplo.toml
  • TODO.md
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/pinnacle-comp/pinnacle)](https://www.repo-grade.com/report/pinnacle-comp/pinnacle)

More graded Rust repos