fstarlang/fstar
Grade a repo

0

/ 100

GradeD

Strong community interest, but tests, CI, or docs need work.

Higher than 48% of 5,156 graded repos

A Proof-oriented Programming Language

Documentation75
Engineering42
Health100
F*3,047Apache-2.01mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (81).

See your top fixes
Now
D
64
Potential
B
81

Top fixes

Highest-impact changes first, ranked by point weight

20 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  4. 4
    CI/CD14pt

    Add a lint step to catch style issues automatically.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

75

README12pt55

README is present.

Contributing guide5pt67

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

42

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt40

CI is configured (.github/workflows/build-all.yml).

Tests18pt80

Test files detected (.scripts/fstardoc/tests).

Project health

100

Dependency manifest6pt100

Dependency manifest found (examples/algorithms/algorithms.sln).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 256
    Forks
  • 90
    Releaseslatest 9y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 3,047
    Watchers

Responsiveness

  • 1h
    Median issue response
  • 9h
    Median PR merge time
  • 561
    Open issues
Repository files42 root entries
  • .ci
  • .completion
  • .copilot
    Good: .gitignore present.
  • .devcontainer
  • .docker
    Good: Environment pinned via .docker/base/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/build-all.yml).
  • .hooks
  • .nix
  • .scripts
    Good: Test files detected (.scripts/fstardoc/tests).
  • .vscode
  • bare-tests
  • contrib
  • doc
  • examples
    Good: Dependency manifest found (examples/algorithms/algorithms.sln).
  • fsharp
  • mk
  • pulse
  • src
  • stage0
  • stage1
  • stage2
  • stage3
  • tests
  • ulib
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .ignore
  • .merlin
  • CHANGES.md
  • 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.
  • flake.lock
  • flake.nix
  • FStar.fst.config.json
  • fstar.opam
  • INSTALL.md
  • karamel
  • LICENSE
    Good: Licensed under Apache-2.0.
  • LICENSE-fsharp.txt
  • Makefile
  • 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.
    Issue: 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.
    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.
  • version.txt
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/fstarlang/fstar)](https://www.repo-grade.com/report/fstarlang/fstar)

More graded F* repos