postalserver/postal

0

/ 100

Documentation61
Engineering81
Health100
Ruby16,610MIT15d ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

📮 A fully featured open source mail delivery platform for incoming & outgoing e-mail

Documentation

61

Install and run instructions9pt45

README documents how to install the project.

README12pt50

README is present.

Contributing guide5pt70

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

License6pt100

Licensed under MIT.

Engineering

81

CI/CD14pt68

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

Tests18pt80

Test files detected (spec).

Reproducibility6pt80

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

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 files33 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • app
  • bin
  • config
  • db
  • doc
  • docker
  • lib
  • log
  • public
  • resource
  • script
  • spec
    Good: Test files detected (spec).
  • tmp
  • vendor
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .release-please-manifest.json
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-version
  • CHANGELOG.md
  • config.ru
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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).
    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.
    Good: Contributing guide includes code examples.
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • MIT-LICENCE
  • Procfile.dev
  • Rakefile
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    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.
  • release-please-config.json
  • SECURITY.md
    Good: Security policy present.