vmfunc/sif
Grade a repo

0

/ 100

GradeA

Polished and well engineered. Punching above its star count.

Top 10% of 5,156 graded repos

the blazing-fast pentesting suite.

Documentation96
Engineering87
Health100
Go433BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

4 to address
  1. 1
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  2. 2
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  3. 3
    Issue and PR templates6pt

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

  4. 4
    Contributing guide5pt

    Show new contributors how to get a local dev environment running.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

96

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt93

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under BSD-3-Clause.

Engineering

87

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.

Reproducibility6pt95

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (internal/config/config_test.go).

CI/CD14pt100

CI is configured (.github/workflows/check-large-files.yml).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

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)
  • 28
    Forks
  • 64
    Releaseslatest 1y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 433
    Watchers

Responsiveness

  • 21d 17h
    Median issue response
  • <1h
    Median PR merge time
  • 11
    Open issues
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/check-large-files.yml).
    Good: Dependabot covers 2 ecosystems (gomod, github-actions). Dependencies stay current.
  • assets
  • cmd
  • docs
  • internal
    Good: Test files detected (internal/config/config_test.go).
  • man
  • modules
  • .all-contributorsrc
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • 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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • flake.lock
  • flake.nix
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • Makefile
  • notify_test.go
  • 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.
    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.
  • sif_test.go
  • sif.code-workspace
  • sif.go
  • template-example.toml
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/vmfunc/sif)](https://www.repo-grade.com/report/vmfunc/sif)

More graded Go repos