canokeys/canokey-core

0

/ 100

Documentation82
Engineering64
Health100
C408Apache-2.01d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Core implementations of an open-source secure key

Documentation

82

Contributing guide5pt5

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 Apache-2.0.

Engineering

64

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.

Tests18pt80

Test files detected (test-via-pcsc/admin_test.go).

CI/CD14pt85

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

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

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)
  • 46
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 408
    Watchers

Responsiveness

  • 11h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files29 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
  • applets
  • cmake
  • fuzzer
  • fuzzing
  • include
  • interfaces
  • scripts
  • src
  • test
  • test-real
    Good: Code of conduct present.
  • test-via-pcsc
    Good: Test files detected (test-via-pcsc/admin_test.go).
    Good: Environment pinned via test-via-pcsc/Dockerfile.
  • virt-card
  • .clang-format
  • .coveralls.yml
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • AGENTS.md
  • canokey-crypto
  • CMakeLists.txt
  • DESIGN.md
  • FIDO2 Conformance Testing.json
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • littlefs
  • llvm-gcov.sh
  • 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.
  • tinycbor