lostisland/faraday

0

/ 100

Documentation88
Engineering91
Health100
Ruby5,944MIT8d ago
Grade a repo

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

Simple, but flexible HTTP client library, with support for multiple backends.

Documentation

88

Contributing guide5pt77

CONTRIBUTING guide found.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

91

Tests18pt80

Test files detected (bin/test).

Reproducibility6pt90

Lockfile present (package-lock.json). Installs are reproducible.

CI/CD14pt100

CI is configured (.github/workflows/ci.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 files26 root entries
  • .ai
  • .claude
  • .github
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (bundler, github-actions, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • bin
    Good: Test files detected (bin/test).
  • config
  • docs
  • examples
  • lib
  • spec
  • .cursorrules
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .rspec
  • .rubocop_todo.yml
  • .rubocop.yml
  • .yardopts
  • CHANGELOG.md
  • faraday.gemspec
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE.md
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
  • 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.
  • SECURITY.md
    Good: Security policy present.
  • UPGRADING.md