scikit-learn-contrib/fastcan

0

/ 100

Documentation59
Engineering85
Health100
Python24MIT1d ago
Grade a repo

Solid foundation. Invest in docs and CI to grow from here.

A fast canonical-correlation-based search algorithm for feature selection, system identification, data pruning, etc.

Documentation

59

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.

README12pt40

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

85

Reproducibility6pt10

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/ci.yml).

Tests18pt100

Test files detected (fastcan/narx/tests).

Linting and formatting5pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

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)
  • 5
    Forks
  • 53
    Releaseslatest 1y ago

Community

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

Responsiveness

  • 6h
    Median issue response
  • <1h
    Median PR merge time
  • 8
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • asv_benchmarks
  • doc
    Good: Environment pinned via doc/environment.yml.
  • examples
  • fastcan
    Good: Test files detected (fastcan/narx/tests).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .readthedocs.yml
  • LICENSE
    Good: Licensed under MIT.
  • meson.build
  • pixi.lock
  • pixi.toml
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.rst
    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.
    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.
    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.