rapid7/metasploit-framework

0

/ 100

Documentation77
Engineering86
Health100
Ruby38,437Other5d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Metasploit Framework

Documentation

77

README12pt55

README is present.

Contributing guide5pt80

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

86

Tests18pt80

Test files detected (external/serialport/test).

Reproducibility6pt80

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

CI/CD14pt85

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

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 files61 root entries
  • .github
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • .kiro
  • app
  • config
  • data
  • db
  • docker
  • docs
  • documentation
  • external
    Good: Test files detected (external/serialport/test).
  • kubernetes
  • lib
  • modules
  • plugins
  • script
  • scripts
  • spec
  • test
  • tools
  • .dockerignore
  • .git-blame-ignore-revs
  • .gitignore
    Good: .gitignore present.
  • .gitleaksignore
  • .gitmodules
  • .mailmap
  • .rspec
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-gemset
  • .ruby-version
  • .simplecov
  • .snyk
  • .solargraph.yml
  • .yardopts
  • AGENTS.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.
    Good: Contributing guide describes code style expectations.
    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.
  • COPYING
  • cortex.yaml
  • CURRENT.md
  • docker-compose.override.yml
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.local.example
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under Other.
  • LICENSE_GEMS
  • metasploit-framework.gemspec
  • msf-json-rpc.ru
  • msf-ws.ru
  • msfconsole
  • msfd
  • msfdb
  • msfmcpd
  • msfrpc
  • msfrpcd
  • msfupdate
  • msfvenom
  • Rakefile
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    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.
    Good: README documents how to run the project.
  • Vagrantfile