lorint/brick

0

/ 100

Documentation82
Engineering38
Health94
Ruby385Other1d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Auto-generate models, views, controllers, and routes in a Rails app based on database structure

Documentation

82

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

38

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Linting and formatting5pt0

No RuboCop config found.

→ Add a .rubocop.yml and run `rubocop` in CI to enforce consistent Ruby style.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt70

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

Tests18pt80

Test files detected (spec).

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)
  • 9
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 385
    Watchers

Responsiveness

  • 9h
    Median issue response
  • 7h
    Median PR merge time
  • 5
    Open issues
Repository files15 root entries
  • docs
  • gemfiles
  • lib
  • spec
    Good: Test files detected (spec).
    Issue: Build artifacts or local files may be committed (spec/test_app/app/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • v1.0
  • vendor
  • .gitignore
    Good: .gitignore present.
  • Appraisals
  • brick.gemspec
  • CHANGELOG.md
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under Other.
  • 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.
    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.
    Good: README documents how to run the project.