presidentbeef/brakeman

0

/ 100

Documentation90
Engineering63
Health100
Ruby7,247Other9d ago
Grade a repo

Good community traction and solid fundamentals. Nearly in the top tier.

A static analysis security vulnerability scanner for Ruby on Rails applications

Documentation

90

Contributing guide5pt77

Contributing guide is detailed and thorough.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

63

Linting and formatting5pt0

No RuboCop config found.

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

CI/CD14pt40

CI is configured (.github/workflows/docker-hub-push.yml).

Tests18pt80

Test files detected (test).

Reproducibility6pt80

Lockfile present (test/apps/rails3.1/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 files28 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/docker-hub-push.yml).
    Good: Issue or PR templates present.
  • bin
  • docs
  • lib
  • test
    Good: Test files detected (test).
    Good: Lockfile present (test/apps/rails3.1/Gemfile.lock). Installs are reproducible.
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • brakeman-lib.gemspec
  • brakeman-min.gemspec
  • brakeman-public_cert.pem
  • brakeman.gemspec
  • build.rb
  • CHANGES.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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.
    Good: Contributing guide includes code examples.
  • COPYING.md
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.codeclimate
  • FEATURES
  • gem_common.rb
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE.md
    Good: Licensed under Other.
  • MIT-LICENSE
  • OPTIONS.md
  • 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.
  • SECURITY.md
    Good: Security policy present.