rtic-rs/rtic
Grade a repo

91

/ 100

GradeA

A well-known project done right. Strong docs and solid engineering throughout.

Top 11% of 5,156 graded repos

Real-Time Interrupt-driven Concurrency (RTIC) framework for ARM Cortex-M microcontrollers

Documentation92
Engineering87
Health100
Rust2,355Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  2. 2
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  3. 3
    Issue and PR templates6pt

    Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

  4. 4
    Issue and PR templates6pt

    A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

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

92

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

87

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.

Reproducibility6pt90

Lockfile present (examples/embassy-stm32g4/Cargo.lock). Installs are reproducible.

Tests18pt100

Test files detected (rtic-macros/tests).

CI/CD14pt100

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

Linting and formatting5pt100

Rust linting configured (cargo fmt in CI).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Cargo.toml).

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

  • 1 / 19
    Commits (30d / 90d)
  • 255
    Forks
  • 0
    Releases

Community

  • 50% - Fair
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 2,355
    Watchers

Responsiveness

  • 16h
    Median issue response
  • <1h
    Median PR merge time
  • 61
    Open issues
Repository files25 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, cargo). Dependencies stay current.
  • book
  • ci
  • examples
    Good: Lockfile present (examples/embassy-stm32g4/Cargo.lock). Installs are reproducible.
  • rtic
  • rtic-common
  • rtic-macros
    Good: Test files detected (rtic-macros/tests).
  • rtic-monotonics
  • rtic-sync
  • rtic-time
  • xtask
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • check-book.sh
  • CNAME
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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.
    Good: Contributing guide includes code examples.
  • LICENSE-APACHE
  • LICENSE-CC-BY-SA
  • LICENSE-MIT
  • README_ru.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.
  • README.md
  • redirect.html
  • rust-toolchain.toml
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/rtic-rs/rtic)](https://www.repo-grade.com/report/rtic-rs/rtic)

More graded Rust repos