semaphorep/codeastro

0

/ 100

Jupyter Notebook233BSD-3-Clause1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

Course Material for the Code/Astro Workshop

Documentation

68

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.

README12pt65

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

9

Tests18pt0

No tests detected anywhere in the repository.

Add automated tests. They prove the code works and give contributors confidence to make changes.

CI/CD14pt0

No CI configuration detected in this repository.

If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

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.

Reproducibility6pt70

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

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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

Community

  • Community health
  • authors own >50% of commits
  • 233
    Watchers

Responsiveness

  • 5d 18h
    Median issue response
  • <1h
    Median PR merge time
  • 26
    Open issues
Repository files14 root entries
  • Day0
  • Day1
  • Day2
  • Day3
  • Day4
  • Day5
  • docs
  • example_data
  • imgs
  • .gitignore
    Good: .gitignore present.
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • 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.
    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.
    Good: README includes status badges.
    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).
  • workshop_info.md