aigc-apps/pai-rag

0

/ 100

Documentation84
Engineering77
Health96
Python470MIT1d ago
Grade a repo

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

An easy-to-use framework for modular RAG

Documentation

84

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.

README12pt100

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

77

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/CD14pt72

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

Reproducibility6pt80

Lockfile present (poetry.lock). Installs are reproducible.

Tests18pt100

Test files detected (integrations/pairag-file/tests).

Linting and formatting5pt100

Linter or formatter configured (frontend/.eslintrc.json).

Project health

96

Dependency manifest6pt86

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)
  • 74
    Forks
  • 12
    Releaseslatest 5mo ago

Community

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

Responsiveness

  • 4d 17h
    Median issue response
  • 1h
    Median PR merge time
  • 0
    Open issues
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • alembic
  • backend
  • docker
  • docs
  • examples
  • frontend
    Good: Linter or formatter configured (frontend/.eslintrc.json).
  • integrations
    Good: Test files detected (integrations/pairag-file/tests).
  • resources
  • scripts
  • skills
  • tests
  • .dockerignore
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • alembic.ini
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.api
  • Dockerfile.base
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • poetry.lock
    Good: Lockfile present (poetry.lock). Installs are reproducible.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • 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.