freebsd/freebsd-doc
Grade a repo

0

/ 100

GradeF

Getting noticed, but rough fundamentals could turn visitors away.

FreeBSD doc tree (read-only mirror)

Documentation38
Engineering22
Health68
HTML385Othertoday

Documentation

38

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt20

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

License6pt100

Licensed under Other.

Engineering

22

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

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.

CI/CD14pt40

CI is configured (.github/workflows/label-pull-requests.yml).

Linting and formatting5pt100

Linter or formatter configured (documentation/.editorconfig).

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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

Community

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

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 41
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/label-pull-requests.yml).
  • .hooks
  • .vale
  • documentation
    Good: Licensed under Other.
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Linter or formatter configured (documentation/.editorconfig).
  • shared
  • tools
  • website
  • .arcconfig
  • .cirrus.yml
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mailmap
  • .vale.ini
  • COPYRIGHT
  • Makefile
  • README
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.