pqrs-org/karabiner-elements

0

/ 100

Documentation82
Engineering56
Health100
C++22,344Unlicense5d ago
Grade a repo

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

Karabiner-Elements is a powerful tool for customizing keyboards on macOS

Documentation

82

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Unlicense.

Engineering

56

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

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 (tests).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (tools/clean-launch-services-database/Package.swift).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • .vscode
  • appendix
  • docs
  • files
  • pkginfo
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • tools
    Good: Dependency manifest found (tools/clean-launch-services-database/Package.swift).
  • vendor
  • .clang-format
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .markdownlint.json
  • .prettierrc.json
  • .swiftlint.yml
  • DEVELOPMENT.md
  • LICENSE.md
    Good: Licensed under Unlicense.
  • make-package.sh
  • Makefile
  • NEWS.md
  • README.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.
  • SECURITY.md
    Good: Security policy present.
  • TASKS.md
  • version