openfoodfoundation/openfoodnetwork

0

/ 100

Documentation90
Engineering88
Health94
Ruby1,253AGPL-3.01d ago
Grade a repo

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

Connect suppliers, distributors and consumers to trade local produce.

Documentation

90

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt92

Contributing guide is detailed and thorough.

License6pt100

Licensed under AGPL-3.0.

Engineering

88

Tests18pt80

Test files detected (docker/test).

CI/CD14pt85

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

Linting and formatting5pt100

Ruby linting configured (.prettierrc.json).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 794
    Forks
  • 426
    Releaseslatest 11y ago

Community

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

Responsiveness

  • 1d 13h
    Median issue response
  • 14d 17h
    Median PR merge time
  • 659
    Open issues
Repository files60 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot covers 6 ecosystems (bundler, npm, bundler, npm, bundler, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • .tx
  • app
  • bin
  • config
  • db
  • doc
  • docker
    Good: Test files detected (docker/test).
  • engines
  • lib
  • log
  • public
  • reports
  • script
  • spec
  • swagger
  • vendor
  • .dockerignore
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .env.development
  • .env.test
  • .foreman
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .haml-lint_todo.yml
  • .haml-lint.yml
  • .mailmap
  • .node-version
  • .prettierignore
  • .prettierrc.json
    Good: Ruby linting configured (.prettierrc.json).
  • .rspec
  • .rubocop_relaxed_styleguide.yml
  • .rubocop_rspec_styleguide.yml
  • .rubocop_styleguide.yml
  • .rubocop_todo.yml
  • .rubocop.yml
  • .ruby-gemset
  • .ruby-version
  • .secrets.example
  • .simplecov
  • .undercover
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • compose.yaml
  • config.ru
  • 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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.ubuntu
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • GETTING_STARTED.md
  • jest.config.js
  • knapsack_rspec_report.json
  • LICENCE.txt
    Good: Licensed under AGPL-3.0.
  • package.json
  • postcss.config.js
  • Procfile
  • Procfile.docker
  • Rakefile
  • 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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • yarn.lock