jj-vcs/jjNew scan
81/ 100 · B

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

A Git-compatible VCS that is both simple and powerful

Rust29,597 starsApache-2.0updated 2d ago
DocumentationREADME, setup, examples, license
84
EngineeringTests, CI, linting, lockfiles
76
Project healthDescription, activity, stars, deps
91

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Detailed breakdown

Documentation

84
  • README65
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide98
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

76
  • Tests60
    • Test files detected (cli/tests).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/ci.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (.editorconfig).
    • No linter or type checker configured in pyproject.toml (−80 pts).Add [tool.ruff] for linting and [tool.mypy] for type checking to pyproject.toml.
  • Reproducibility90
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • Dependabot covers 4 ecosystems (cargo, github-actions, nix, npm). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

91
  • Dependency manifest85
    • Dependency manifest found (Cargo.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 29,597 stars.
  • Housekeeping100
    • .gitignore present.
Repository files29 root entries
  • .cargo
  • .config
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 4 ecosystems (cargo, github-actions, nix, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • cli
    Good: Test files detected (cli/tests).
  • demos
  • docs
  • lib
  • web
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .envrc.recommended
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .watchmanconfig
  • AUTHORS
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • default.nix
  • deny.toml
  • flake.lock
  • flake.nix
  • GOVERNANCE.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • mkdocs.yml
  • pyproject.toml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
    Info: 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rustfmt.toml
  • SECURITY.md
    Good: Security policy present.
  • uv.lock