hacf-fr/renault-api

0

/ 100

Documentation72
Engineering78
Health84
Python183MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Documentation

72

README12pt40

README is present.

Contributing guide5pt80

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

78

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 (poetry.lock). Installs are reproducible.

CI/CD14pt85

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

Tests18pt95

Test files detected (tests).

Linting and formatting5pt100

Linter or formatter configured (tests/ruff.toml).

Project health

84

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.

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

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)
  • 85
    Forks
  • 48
    Releaseslatest 5y ago

Community

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

Responsiveness

  • 5h
    Median issue response
  • <1h
    Median PR merge time
  • 11
    Open issues
Repository files21 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
  • .vscode
  • docs
  • src
  • tests
    Good: Test files detected (tests).
    Good: Linter or formatter configured (tests/ruff.toml).
  • .cookiecutter.json
  • .darglint
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yml
  • .safety-policy.yml
  • CODE_OF_CONDUCT.rst
    Good: Code of conduct present.
  • codecov.yml
  • CONTRIBUTING.rst
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE.rst
    Good: Licensed under MIT.
  • noxfile.py
  • poetry.lock
    Good: Lockfile present (poetry.lock). Installs are reproducible.
  • poetry.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.