Well engineered for its size. A portfolio piece worth showing off.

Best practices and guidelines for AI agents in software development

Documentation

82

README12pt70

README is present.

Contributing guide5pt72

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

A license file is present.

Engineering

100

Tests18pt100

Test files detected (cmd/deft-install/deposit_test.go).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (biome.json).

Reproducibility6pt100

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

92

Dependency manifest6pt75

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)
  • 10
    Forks
  • 99
    Releaseslatest 4mo ago

Community

  • Community health
  • authors own >50% of commits
  • 28
    Watchers

Responsiveness

  • 1d 17h
    Median issue response
  • 3h
    Median PR merge time
  • 501
    Open issues
Repository files43 root entries
  • .githooks
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (pip, gomod, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • .planning
  • cmd
    Good: Test files detected (cmd/deft-install/deposit_test.go).
  • content
    Good: A license file is present.
    Good: Security policy present.
  • docs
  • history
  • incidents
  • meta
  • packages
  • scripts
  • specs
  • tasks
  • tests
  • vbrief
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • AGENTS.md
  • biome.json
    Good: Linter or formatter configured (biome.json).
  • CHANGELOG.md
  • 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.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • main.md
  • package.json
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • PRD.md
  • PROJECT.md
  • pyproject.toml
  • 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.
  • REFERENCES.md
  • ROADMAP.md
  • run
  • run.bat
  • run.py
  • SKILL.md
  • SPECIFICATION.md
  • Taskfile.yml
  • tsconfig.base.json
  • tsconfig.json
  • uv.lock
  • vitest.config.ts