dahlia/optique

0

/ 100

Documentation67
Engineering55
Health100
TypeScript701MIT1d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Type-safe combinatorial CLI parser for TypeScript

Documentation

67

Contributing guide5pt0

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.

README12pt60

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

55

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.

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/main.yaml).

Tests18pt80

Test files detected (examples/gitique/src/index.test.ts).

Reproducibility6pt80

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

Project health

100

Dependency manifest6pt100

Dependency manifest found (pnpm-workspace.yaml).

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

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 701
    Watchers

Responsiveness

  • 11h
    Median issue response
  • 1h
    Median PR merge time
  • 5
    Open issues
Repository files32 root entries
  • .agents
  • .claude
  • .github
    Good: CI is configured (.github/workflows/main.yaml).
  • .vscode
  • .zed
  • docs
  • examples
    Good: Test files detected (examples/gitique/src/index.test.ts).
  • packages
  • scripts
  • .cursorrules
  • .gitignore
    Good: .gitignore present.
  • .hongdown.toml
  • .windsurfrules
  • AGENT.md
  • AGENTS.md
  • AI_POLICY.md
  • CHANGES.md
  • CLAUDE.md
  • codecov.yml
  • context7.json
  • cspell.json
  • deno.json
  • deno.lock
  • GEMINI.md
  • LICENSE
    Good: Licensed under MIT.
  • mise.toml
    Good: Environment pinned via mise.toml.
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
    Good: Dependency manifest found (pnpm-workspace.yaml).
  • readme-imports.test.ts
    Good: README is present.
    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.
    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.
    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.
  • README.md
  • SECURITY.md
    Good: Security policy present.
  • skills-lock.json