zongruxie4/raven
Grade a repo

0

/ 100

GradeB

Solid engineering. The main gap is visibility.

Top 28% of 5,156 graded repos

CI/CD Security Analyzer

Documentation92
Engineering80
Health68
0Apache-2.01y ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Contributing guide5pt

    Add setup instructions, code style notes, and how to run tests.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

92

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

80

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.

Tests18pt80

Test files detected (tests).

Reproducibility6pt80

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

CI/CD14pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

68

Activity5pt20

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

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

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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 files19 root entries
  • .github
    Good: CI is configured (.github/workflows/test_pr.yml).
    Good: Issue or PR templates present.
  • assets
  • deployment
    Good: Environment pinned via deployment/docker-compose.yml.
  • docs
  • library
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • dev-requirements.in
  • dev-requirements.txt
  • LICENSE.md
    Good: Licensed under Apache-2.0.
  • main.py
  • Makefile
  • MANIFEST.in
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.in
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • setup.py
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/zongruxie4/raven)](https://www.repo-grade.com/report/zongruxie4/raven)

More graded repos