we-promise/sure

0

/ 100

Documentation84
Engineering85
Health100
Ruby8,723AGPL-3.05d ago
Grade a repo

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

The personal finance app for everyone (by everyone)

Documentation

84

Install and run instructions9pt55

README documents how to install the project.

Contributing guide5pt79

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

85

CI/CD14pt72

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

Tests18pt80

Test files detected (charts/sure/templates/tests).

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Reproducibility6pt100

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

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 files54 root entries
  • .cursor
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .gemini
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (bundler, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .junie
  • app
  • bin
  • charts
    Good: Test files detected (charts/sure/templates/tests).
  • config
  • db
  • design
  • docs
  • lib
  • log
  • mobile
  • public
  • spec
  • storage
  • test
  • tmp
  • vendor
  • workers
  • .dockerignore
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .env.example
  • .env.local.example
  • .env.test.example
  • .erb_lint.yml
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .rspec
  • .rubocop.yml
  • .ruby-version
  • .sure-version
  • AGENTS.md
  • biome.json
  • CLAUDE.md
  • compose.example.ai.yml
  • compose.example.yml
  • 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.
    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.
    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
  • Dockerfile.preview
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • package-lock.json
  • package.json
  • perf.rake
  • pipelock.example.yaml
  • Procfile.dev
  • 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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.