naod-mergiya/solar-challenge-week1

0

/ 100

Documentation52
Engineering54
Health57
Jupyter Notebook21y ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

Documentation

52

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

54

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

Reproducibility6pt70

Lockfile present (requirements.txt). Installs are reproducible.

Tests18pt80

Test files detected (tests).

Project health

57

Activity5pt20

No pushes in over a year (−80 pts).

→ A recent commit signals the project is alive and worth contributing to.

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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
  • 2
    Watchers

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files13 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • .vscode
  • app
    Issue: Build artifacts or local files may be committed (app/__pycache__/utils.cpython-312.pyc) (−40 pts).Fix: Remove them and add to .gitignore.
  • data
  • notebooks
  • plots
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • 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.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).