shining-man/bsc_fw

0

/ 100

Documentation47
Engineering41
Health68
C++153MIT1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

Firmware battery safety controller (BSC)

Documentation

47

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

README12pt75

README is present.

License6pt100

Licensed under MIT.

Engineering

41

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.

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/CD14pt40

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

Tests18pt80

Test files detected (lib/Dallas/test).

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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)
  • 26
    Forks
  • 28
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 3h
    Median issue response
  • 8h
    Median PR merge time
  • 57
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
  • .vscode
  • boards
  • doc
  • include
  • lang
  • lib
    Good: Test files detected (lib/Dallas/test).
  • scripts
  • src
  • test
  • .gitignore
    Good: .gitignore present.
  • changes.txt
  • default_bsc_neu.csv
  • default_bsc.csv
  • LICENSE
    Good: Licensed under MIT.
  • platformio.ini
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • spons