Strong community interest, but tests, CI, or docs need work.

A guide to contributing to open source

Documentation

90

README12pt85

README is present.

Contributing guide5pt89

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under CC-BY-SA-4.0.

Engineering

39

Tests18pt0

No tests detected anywhere in the repository.

Add automated tests. They prove the code works and give contributors confidence to make changes.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

Commit Gemfile.lock so Bundler installs are repeatable.

CI/CD14pt57

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

Linting and formatting5pt100

Linter or formatter configured (.eslintrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

47

Dependency manifest6pt0

No dependency manifest detected at root.

Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

Activity5pt20

No pushes in over a year (−80 pts).

A recent commit signals the project is alive and worth contributing to.

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files45 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Issue or PR templates present.
  • .eslintrc
    Good: Linter or formatter configured (.eslintrc).
  • .gitignore
    Good: .gitignore present.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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.
  • Dangerfile
  • LICENSE.md
    Good: Licensed under CC-BY-SA-4.0.
  • PROJECTS.md
  • README-AR.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.
    Good: README documents how to run the project.
  • README-BG.md
  • README-BN.md
  • README-CN.md
  • README-DE.md
  • README-ES.md
  • README-FA.md
  • README-FR.md
  • README-GR.md
  • README-GU.md
  • README-HE.md
  • README-HI.md
  • README-HY.md
  • README-ID.md
  • README-IT.md
  • README-JA.md
  • README-KO.md
  • README-ML.md
  • README-MR.md
  • README-MS.md
  • README-NE.md
  • README-NL.md
  • README-PL.md
  • README-pt-BR.md
  • README-RO.md
  • README-RU.md
  • README-SA.md
  • README-SI.md
  • README-SL.md
  • README-TA.md
  • README-TE.md
  • README-TR.md
  • README-UK.md
  • README-UR.md
  • README-UZ.md
  • README-VI.md
  • README.md