Well engineered for its size. A portfolio piece worth showing off.
Best practices and guidelines for AI agents in software development
Documentation
82
README is present.
Contributing guide is detailed and thorough.
README documents how to install the project.
A license file is present.
Engineering
100
Test files detected (cmd/deft-install/deposit_test.go).
CI is configured (.github/workflows/ci.yml).
Linter or formatter configured (biome.json).
Lockfile present (pnpm-lock.yaml). Installs are reproducible.
Issue or PR templates present.
Project health
92
Dependency manifest found (go.mod).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 10Forks
- 99Releaseslatest 4mo ago
Community
- —Community health
- —authors own >50% of commits
- 28Watchers
Responsiveness
- 1d 17hMedian issue response
- 3hMedian PR merge time
- 501Open issues
Repository files43 root entries
- .githooks
- .githubGood: 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
- cmdGood: Test files detected (cmd/deft-install/deposit_test.go).
- contentGood: A license file is present.Good: Security policy present.
- docs
- history
- incidents
- meta
- packages
- scripts
- specs
- tasks
- tests
- vbrief
- .gitattributes
- .gitignoreGood: .gitignore present.
- .nvmrcGood: Environment pinned via .nvmrc.
- AGENTS.md
- biome.jsonGood: Linter or formatter configured (biome.json).
- CHANGELOG.md
- CONTRIBUTING.mdGood: 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.modGood: Dependency manifest found (go.mod).
- main.md
- package.json
- pnpm-lock.yamlGood: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
- pnpm-workspace.yaml
- PRD.md
- PROJECT.md
- pyproject.toml
- README.mdGood: 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