jamesspro/pdk_upvfab_v2

0

/ 100

Documentation67
Engineering74
Health71
0MIT8mo ago
Grade a repo

Solid engineering. The main gap is visibility.

My test to a new version of the UPVfab SiN PDK

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

74

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.

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

CI/CD14pt85

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

Tests18pt100

Test files detected (tests).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Project health

71

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt93

Dependency manifest found (pyproject.toml).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/test_code.yml).
    Good: Dependabot covers 2 ecosystems (pip, github-actions). Dependencies stay current.
  • .vscode
  • docs
  • tests
    Good: Test files detected (tests).
  • training
  • upvfab
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .sourcery.yaml
  • CHANGELOG.md
  • install_tech.py
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.