aws-samples/sample-cdk-rds-pg-memdb-text-to-sql

0

/ 100

Documentation82
Engineering38
Health95
Python6MIT-02mo ago
Grade a repo

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

In the below URL, we explore how to use Amazon RDS for PostgreSQL and Amazon Bedrock, along with Amazon MemoryDB with vector search to provide semantic caching, to build a generative AI text-to-SQL chatbot application using Retrieval Augmented Generation (RAG)

Documentation

82

README12pt70

README is present.

Contributing guide5pt72

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT-0.

Engineering

38

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.

Tests18pt80

Test files detected (code/tests).

Project health

95

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 3
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 1
    Open issues
Repository files15 root entries
  • cdk_rds_pg_memdb_text_to_sql
  • code
    Good: Test files detected (code/tests).
  • custom_resource
  • streamlit
  • .gitignore
    Good: .gitignore present.
  • app.py
  • cdk.json
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    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.
    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.
    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
    Good: Licensed under MIT-0.
  • 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-dev.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • setup_helper.py
  • source.bat