misxzaiz/polaris
Grade a repo

0

/ 100

GradeC

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

Top 39% of 5,156 graded repos
Documentation59
Engineering87
Health73
TypeScript1111mo ago

Top fixes

Highest-impact changes first, ranked by point weight

13 to address
  1. 1
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  2. 2
    Install and run instructions9pt

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

  3. 3
    License6pt

    Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

  4. 4
    Reproducibility6pt

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

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

59

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

87

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.

Reproducibility6pt90

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Tests18pt100

Test files detected (src-tauri/tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (eslint.config.js).

Project health

73

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt65

Dependency manifest found (package.json).

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)
  • 19
    Forks
  • 27
    Releaseslatest 3mo ago

Community

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

Responsiveness

  • 4h
    Median issue response
  • 9h
    Median PR merge time
  • 13
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
  • .vscode
  • docs
  • examples
  • public
  • scripts
  • src
  • src-tauri
    Good: Test files detected (src-tauri/tests).
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • commitlint.config.mjs
  • eslint.config.js
    Good: Linter or formatter configured (eslint.config.js).
  • index.html
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • postcss.config.js
  • 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.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tailwind.config.js
  • tsconfig.json
  • tsconfig.node.json
  • vite.config.ts
  • vitest.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/misxzaiz/polaris)](https://www.repo-grade.com/report/misxzaiz/polaris)

More graded TypeScript repos