freecodecamp/contribute

0

/ 100

Documentation55
Engineering85
Health89
MDX143BSD-3-Clause1d ago
Grade a repo

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

Begin your contribution journey here.

Documentation

55

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

README12pt85

README is present.

License6pt100

Licensed under BSD-3-Clause.

Engineering

85

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.

Reproducibility6pt80

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

Tests18pt100

Test files detected (tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

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)
  • 367
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 143
    Watchers

Responsiveness

  • 1d 12h
    Median issue response
  • 3h
    Median PR merge time
  • 18
    Open issues
Repository files26 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/build.yml).
  • .husky
  • public
  • src
  • tests
    Good: Test files detected (tests).
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitpod.yml
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .prettierignore
  • astro.config.ts
  • eslint.config.js
  • LICENSE.md
    Good: Licensed under BSD-3-Clause.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • prettier.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.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • renovate.json
  • sample.env
  • tsconfig.json
  • vitest.config.ts
  • vitest.setup.ts
  • wrangler.jsonc