haobogu/rmk

0

/ 100

Documentation92
Engineering66
Health100
Rust1,675Apache-2.01d ago
Grade a repo

Good community traction and solid fundamentals. Nearly in the top tier.

Rust keyboard firmware library with layers, macros, real-time keymap editing, wireless(BLE) and split support

Documentation

92

Contributing guide5pt64

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

66

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.

CI/CD14pt57

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

Tests18pt80

Test files detected (rmk-macro/tests).

Reproducibility6pt80

Lockfile present (docs/pnpm-lock.yaml). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (docs/package.json).

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)
  • 186
    Forks
  • 33
    Releaseslatest 1y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 1,675
    Watchers

Responsiveness

  • 5h
    Median issue response
  • 3h
    Median PR merge time
  • 71
    Open issues
Repository files24 root entries
  • .config
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • .vscode
  • .zed
  • docs
    Good: Lockfile present (docs/pnpm-lock.yaml). Installs are reproducible.
    Good: Dependency manifest found (docs/package.json).
  • examples
  • rmk
  • rmk-config
  • rmk-macro
    Good: Test files detected (rmk-macro/tests).
  • rmk-types
  • scripts
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • 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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE-APACHE
  • LICENSE-MIT
  • README_zh.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
  • rust-toolchain.toml
  • rustfmt.toml