gleam-lang/gleamNew scan
76/ 100 · C

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

⭐️ A friendly language for building type-safe, scalable systems!

Rust21,584 starsApache-2.0updated 4d ago
DocumentationREADME, setup, examples, license
47
EngineeringTests, CI, linting, lockfiles
90
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    README
    DocumentationInfo

    Expand with a description, install steps, usage, and examples.

Detailed breakdown

Documentation

47
  • README40
    • README is present.
    • README is fairly short (worth +10 pts; 1,500+ characters earns the full +20 pts).Expand with a description, install steps, usage, and examples.
    • README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    • 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 instructions0
    • No install instructions found in the README (−45 pts).Add a section showing how to install dependencies.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use 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 guide83
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

90
  • Tests90
    • Test files detected (benchmark/list/test).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/ci.yaml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • 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).
  • 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 6 ecosystems (github-actions, cargo, cargo, cargo, cargo, cargo). Dependencies stay current.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

92
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 21,584 stars.
  • Housekeeping100
    • .gitignore present.
Repository files38 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yaml).
    Good: Dependabot covers 6 ecosystems (github-actions, cargo, cargo, cargo, cargo, cargo). Dependencies stay current.
    Good: Issue or PR templates present.
  • .vscode
  • .well-known
  • benchmark
    Good: Test files detected (benchmark/list/test).
  • bin
  • changelog
  • compiler-cli
  • compiler-core
  • compiler-wasm
  • containers
  • docs
  • gleam-bin
  • hexpm
  • images
  • language-server
  • licence-bundler
  • licences
  • test
  • test-commands
  • test-community-packages
  • test-helpers-rs
  • test-output
  • test-package-compiler
  • test-project-compiler
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • 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.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • Cross.toml
  • deny.toml
  • LICENCE
    Good: Licensed under Apache-2.0.
  • Makefile
  • README.md
    Good: README is present.
    Info: README is fairly short (worth +10 pts; 1,500+ characters earns the full +20 pts).Fix: Expand with a description, install steps, usage, and examples.
    Info: README has little structure (0 pts); 2-3 headings earns +8 pts, 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Warning: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Warning: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • RELEASE.md