croct-tech/plug-js
Grade a repo

95

/ 100

GradeA

Excellent work. The main thing left to polish is a contributing guide.

Top 6% of 5,156 graded repos

Croct's official SDK for JavaScript.

Documentation85
Engineering99
Health100
TypeScript106MIT17d ago

Outstanding. A score of 95/100 puts this repo in a very small tier of truly well-engineered projects.

Top fixes

Highest-impact changes first, ranked by point weight

4 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Reproducibility6pt

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

  3. 3
    Contributing guide5pt

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

  4. 4
    Contributing guide5pt

    A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

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

85

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 instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

99

Reproducibility6pt90

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

Tests18pt100

Test files detected (jest.config.mjs).

CI/CD14pt100

CI is configured (.github/workflows/validate-branch.yaml).

Linting and formatting5pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

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

  • 4 / 9
    Commits (30d / 90d)
  • 14
    Forks
  • 101
    Releaseslatest 6y ago

Community

  • 50% - Fair
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 106
    Watchers

Responsiveness

  • 659d
    Median issue response
  • <1h
    Median PR merge time
  • 7
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/validate-branch.yaml).
    Good: Issue or PR templates present.
  • preview
  • src
  • test
  • .gitignore
    Good: .gitignore present.
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • jest.config.mjs
    Good: Test files detected (jest.config.mjs).
  • jest.setup.js
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • post-build.mjs
  • prepare-release.mjs
  • 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.
  • release-config.mjs
  • renovate.json
    Good: Renovate is configured (renovate.json). Dependencies update automatically across every package manager it detects.
  • rollup.config.mjs
  • tsconfig.json
  • tsup.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/croct-tech/plug-js)](https://www.repo-grade.com/report/croct-tech/plug-js)

More graded TypeScript repos