89/ 100 · B
A top-tier open source project. Docs, tests, and CI are all in excellent shape.
A Rust compiler front-end for IDEs
Rust16,551 starsApache-2.0updated 2d ago
DocumentationREADME, setup, examples, license
EngineeringTests, CI, linting, lockfiles
Project healthDescription, activity, stars, deps
What to fix first
The highest-impact improvements for this repo.
- 1READMEDocumentationInfo
Show a quick-start snippet so contributors can see what using your project looks like.
- 2Install and run instructionsDocumentationInfo
Add a .env.example listing all required environment variables so contributors know what to set up.
- 3ReproducibilityEngineeringInfo
Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
Detailed breakdown
Documentation
85- README85
- README is present.
- README is well structured with multiple sections.
- README includes screenshots or visuals. Great for first impressions.
- 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 guide59
- Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.
- 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 lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
- Contributing guide describes the PR/review workflow.
- Contributing guide has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
- 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
90- Tests90
- Test files detected (crates/hir-def/src/expr_store/tests).
- 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.).
- CI reports or uploads test coverage.
- CI tests across multiple environments or versions.
- CI includes a build step.
- Linting and formatting60
- Linter or formatter configured (.editorconfig).
- Reproducibility80
- Lockfile present (Cargo.lock). Installs are reproducible.
- Environment pinned via .github/actions/github-release/Dockerfile.
- No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
- Issue and PR templates100
- Issue or PR templates present.
- Security policy present.
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).
- 16,551 stars.
- Housekeeping100
- .gitignore present.
Repository files32 root entries
- .cargo
- .config
- .githubGood: CI is configured (.github/workflows/ci.yaml).Good: Environment pinned via .github/actions/github-release/Dockerfile.Good: Issue or PR templates present.
- .vscode
- assets
- bench_data
- cratesGood: Test files detected (crates/hir-def/src/expr_store/tests).
- docsGood: Security policy present.
- editorsGood: Licensed under Apache-2.0.
- lib
- xtask
- .codecov.yml
- .editorconfigGood: Linter or formatter configured (.editorconfig).
- .git-blame-ignore-revs
- .gitattributes
- .gitignoreGood: .gitignore present.
- .typos.toml
- AGENTS.md
- AI_POLICY.md
- Cargo.lockGood: Lockfile present (Cargo.lock). Installs are reproducible.
- Cargo.tomlGood: Dependency manifest found (Cargo.toml).
- CLAUDE.md
- clippy.toml
- CONTRIBUTING.mdGood: Contributing guide is present (+6 pts for length); 400+ words earns the full +12 pts.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 .).Info: 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.Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- josh-sync.toml
- LICENSE-APACHE
- LICENSE-MIT
- PRIVACY.md
- README.mdGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.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.
- rust-version
- rustfmt.toml
- triagebot.toml