rocksdanister/lively

0

/ 100

Documentation83
Engineering12
Health95
C#19,028GPL-3.01mo ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

Free and open-source software that allows users to set animated desktop wallpapers and screensavers powered by WinUI 3.

Documentation

83

Contributing guide5pt47

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

12

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Linting and formatting5pt0

No .NET formatter configured.

→ Add an .editorconfig to define C# formatting rules and run `dotnet format` in CI.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Enable and commit packages.lock.json so NuGet restores are repeatable.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

95

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (src/Lively/Lively.Common.Services/Lively.Common.Services.csproj).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files10 root entries
  • .github
    Good: Issue or PR templates present.
  • resources
  • schemas
  • src
    Good: Dependency manifest found (src/Lively/Lively.Common.Services/Lively.Common.Services.csproj).
  • .gitignore
    Good: .gitignore present.
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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.
  • LICENSE
    Good: Licensed under GPL-3.0.
  • PRIVACY.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.
    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.
    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.