securityward/honeyman-project

0

/ 100

Documentation77
Engineering49
Health84
Python9MIT1d ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

Documentation

77

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.

README12pt70

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

49

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.

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.

Tests18pt80

Test files detected (honeyman-v2/agent/tests).

Reproducibility6pt80

Lockfile present (honeyman-v2/dashboard-v2/backend/requirements.txt). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (honeyman-v2/dashboard-v2/frontend/eslint.config.js).

Project health

84

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt100

Dependency manifest found (honeyman-v2/agent/setup.py).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 1
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files10 root entries
  • data
  • honeyman-v2
    Good: Test files detected (honeyman-v2/agent/tests).
    Good: Linter or formatter configured (honeyman-v2/dashboard-v2/frontend/eslint.config.js).
    Good: Lockfile present (honeyman-v2/dashboard-v2/backend/requirements.txt). Installs are reproducible.
    Good: Environment pinned via honeyman-v2/dashboard-v2/backend/Dockerfile.
    Good: Dependency manifest found (honeyman-v2/agent/setup.py).
  • .gitignore
    Good: .gitignore present.
  • ARCHITECTURE.mmd
  • CAPABILITIES.md
  • CHANGELOG.md
  • HONEYMAN-V2-PLAN.md
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
  • TESTING.md