nanomq/nanonng
Grade a repo

0

/ 100

GradeC

Solid foundation. Invest in docs and CI to grow from here.

Top 41% of 5,156 graded repos

The NNG submodule of NanoMQ

Documentation69
Engineering66
Health100
C66MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

17 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 a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

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

69

README12pt40

README is present.

Contributing guide5pt64

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

66

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.

CI/CD14pt57

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

Reproducibility6pt70

Lockfile present (etc/pubrefman/go.sum). Installs are reproducible.

Tests18pt80

Test files detected (tests).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (etc/pubrefman/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)
  • 37
    Forks
  • 60
    Releaseslatest 3y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 66
    Watchers

Responsiveness

  • 12h
    Median issue response
  • 3h
    Median PR merge time
  • 37
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/coverage.yml).
    Good: Issue or PR templates present.
  • cmake
  • demo
  • docs
    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.
  • etc
    Good: Lockfile present (etc/pubrefman/go.sum). Installs are reproducible.
    Good: Dependency manifest found (etc/pubrefman/go.mod).
  • extern
  • include
  • src
  • tests
    Good: Test files detected (tests).
  • .clang-format
  • .codecov.yml
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .grcov.yml
  • CMakeLists.txt
  • CODE_OF_CONDUCT.adoc
    Good: Code of conduct present.
  • LICENSE.txt
    Good: Licensed under MIT.
  • README.adoc
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
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/nanomq/nanonng)](https://www.repo-grade.com/report/nanomq/nanonng)

More graded C repos