mainsail-crew/mainsail
Grade a repo

0

/ 100

GradeA

A well-known project done right. Strong docs and solid engineering throughout.

Top 12% of 5,156 graded repos

Mainsail is the popular web interface for managing and controlling 3D printers with Klipper.

Documentation75
Engineering100
Health89
Vue2,172GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 to address
  1. 1
    README12pt

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

  2. 2
    Install and run instructions9pt

    Add a section showing how to start or use the project.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Dependency manifest6pt

    Add a one-line description to package.json. It appears in npm search and on GitHub.

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

75

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt77

Contributing guide is detailed and thorough.

README12pt85

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

100

Tests18pt100

Test files detected (tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Reproducibility6pt100

Lockfile present (package-lock.json). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

89

Dependency manifest6pt65

Dependency manifest found (package.json).

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)
  • 567
    Forks
  • 90
    Releaseslatest 6y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 2,172
    Watchers

Responsiveness

  • 4h
    Median issue response
  • 3d 6h
    Median PR merge time
  • 115
    Open issues
Repository files30 root entries
  • .docker
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • agent_docs
  • cypress
  • public
  • remote
  • src
  • tests
    Good: Test files detected (tests).
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env.development.local.example
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • cliff-release.toml
  • cliff.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.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    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.
  • cypress.config.ts
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • eslint.config.mjs
  • index.html
  • LICENSE
    Good: Licensed under GPL-3.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
  • tsconfig.json
  • vite.config.ts
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/mainsail-crew/mainsail)](https://www.repo-grade.com/report/mainsail-crew/mainsail)

More graded Vue repos