nomic-ai/gpt4all

0

/ 100

Documentation81
Engineering77
Health79
C++77,376MIT1y ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

GPT4All: Run Local LLMs on Any Device. Open-source and available for commercial use.

Documentation

81

Contributing guide5pt67

Contributing guide is detailed and thorough.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

77

CI/CD14pt57

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

Reproducibility6pt70

Lockfile present (gpt4all-bindings/typescript/yarn.lock). Installs are reproducible.

Tests18pt80

Test files detected (gpt4all-bindings/python/gpt4all/tests).

Linting and formatting5pt100

Linter or formatter configured (gpt4all-chat/.flake8).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

79

Activity5pt20

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

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

Dependency manifest6pt100

Dependency manifest found (gpt4all-bindings/python/setup.py).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files16 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/close_issues.yml).
    Good: Issue or PR templates present.
  • common
  • gpt4all-backend
  • gpt4all-bindings
    Good: Test files detected (gpt4all-bindings/python/gpt4all/tests).
    Good: Lockfile present (gpt4all-bindings/typescript/yarn.lock). Installs are reproducible.
    Good: Dependency manifest found (gpt4all-bindings/python/setup.py).
  • gpt4all-chat
    Good: Linter or formatter configured (gpt4all-chat/.flake8).
  • gpt4all-training
  • .codespellrc
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • 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.
  • gpt4all-lora-demo.gif
  • LICENSE.txt
    Good: Licensed under MIT.
  • MAINTAINERS.md
  • 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.
  • roadmap.md