venhance/napkin
Grade a repo

0

/ 100

GradeF

Real traction, but rough engineering makes it hard for contributors to trust.

An Infinitely Large Napkin

Documentation64
Engineering16
Health68
TeX1,909Othertoday

Documentation

64

Contributing guide5pt5

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt45

README documents how to install the project.

README12pt85

README is present.

License6pt100

Licensed under Other.

Engineering

16

Tests18pt0

No tests detected anywhere in the repository.

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

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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/CD14pt57

CI is configured (.github/workflows/conv-commit.yml).

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

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 1,909
    Watchers

Responsiveness

  • 1d 19h
    Median issue response
  • 7h
    Median PR merge time
  • 22
    Open issues
Repository files24 root entries
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/conv-commit.yml).
  • 3dfigures
  • asy
  • media
  • tex
  • .codespellrc
  • .gitignore
    Good: .gitignore present.
  • .latexmkrc
  • CITATION.cff
  • cover-art.jpg
  • cover-art.png
  • export-flowchart.sh
  • flake.lock
  • flake.nix
  • flowchart-only.tex
  • images.bib
  • LICENSE.md
    Good: Licensed under Other.
  • Napkin.tex
  • patch-asy.sty
  • prek.toml
  • print-toc.py
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • references.bib
  • tikz-cd.sty