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

Free, open source mental health communication web app to share experiences with loved ones

Documentation

71

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt52

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

90

Tests18pt80

Test files detected (client/app/components/Accordion/__tests__).

Reproducibility6pt80

Lockfile present (Gemfile.lock). Installs are reproducible.

CI/CD14pt100

CI is configured (.circleci/config.yml).

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Gemfile).

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)
  • 766
    Forks
  • 310
    Releaseslatest 7y ago

Community

  • Community health
  • authors own >50% of commits
  • 1,631
    Watchers

Responsiveness

  • 3d 14h
    Median issue response
  • 6h
    Median PR merge time
  • 29
    Open issues
Repository files60 root entries
  • .circleci
    Good: CI is configured (.circleci/config.yml).
  • .devcontainer
  • .github
    Good: Issue or PR templates present.
  • .vscode
  • app
  • bin
  • client
    Good: Test files detected (client/app/components/Accordion/__tests__).
  • config
  • db
  • doc
  • git-hooks
  • lib
  • public
  • spec
  • .codeclimate.yml
  • .csslintrc
  • .dockerignore
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .eslintignore
  • .eslintrc
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .nvmrc
  • .rspec
  • .rubocop.yml
  • .ruby-gemset
  • .ruby-version
  • code_of_conduct.md
    Good: Code of conduct present.
  • config.ru
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • CONTRIBUTION_ROADMAP.md
  • docker-compose.test.yml
  • docker-compose.yml
  • docker-entrypoint.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE.txt
    Good: Licensed under AGPL-3.0.
  • package.json
  • Procfile
  • Procfile.dev
  • Rakefile
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • README-BG.md
  • README-BN.md
  • README-CA.md
  • README-CN.md
  • README-ES.md
  • README-FA.md
  • README-FR.md
  • README-HI.md
  • README-ID.md
  • README-IT.md
  • README-KO.md
  • README-LK.md
  • README-PT.md
  • README-TR.md
  • README-VI.md
  • README.md
  • yarn.lock