xlightssequencer/xlights
Grade a repo

0

/ 100

GradeC

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

Top 46% of 5,156 graded repos

xLights is a sequencer for Lights. xLights has usb and E1.31 drivers. You can create sequences in this object oriented program. You can create playlists, schedule them, test your hardware, convert between different sequencers.

Documentation70
Engineering58
Health100
C++725GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

19 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

70

README12pt40

README is present.

Contributing guide5pt67

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

58

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.

CI/CD14pt57

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

Tests18pt80

Test files detected (xLights-Test/tests).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (TipOfDay/Tool/PrepTOD.sln).

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)
  • 256
    Forks
  • 168
    Releaseslatest 6y ago

Community

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

Responsiveness

  • 4d 24h
    Median issue response
  • 9h
    Median PR merge time
  • 65
    Open issues
Repository files56 root entries
  • .github
    Good: CI is configured (.github/workflows/Ubuntu_CI.yml).
    Good: Issue or PR templates present.
  • .vs
  • .vscode
  • bin
  • bin64
  • build_scripts
  • ci_scripts
  • cmake
  • cmudict
  • common
  • dependencies
  • documentation
  • download
  • fseq_convert
  • include
  • lib
  • plans
  • ports
  • resources
  • snap
  • songs
  • src-core
  • src-iPad
  • src-ui-wx
  • TipOfDay
    Good: Dependency manifest found (TipOfDay/Tool/PrepTOD.sln).
  • xlDo
  • xLights
  • xLights-Test
    Good: Test files detected (xLights-Test/tests).
  • .clang-format
  • .clang-tidy
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .travis.yml
  • AGENTS.md
  • appveyor.bat
  • appveyor.yml
  • cbp2make.cfg
  • CLAUDE.md
  • CMakeLists.txt
  • 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).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • dependencies.txt
  • iPad-xLights-Plan.md
  • License.txt
    Good: Licensed under GPL-3.0.
  • macOS
  • Makefile
  • README.linux
    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.
  • README.osx
  • README.txt
  • README.windows
  • ToolConfig.txt
  • vcpkg-configuration.json
  • vcpkg.json
  • VS2022_vcpkg.bat
  • VS2022.bat
  • xLights.xcodeproj
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/xlightssequencer/xlights)](https://www.repo-grade.com/report/xlightssequencer/xlights)

More graded C++ repos