hyprwm/hyprland

0

/ 100

Documentation50
Engineering58
Health68
C++36,434BSD-3-Clause6d ago
Grade a repo

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

Hyprland is an independent, highly customizable, dynamic tiling Wayland compositor that doesn't sacrifice on its looks.

Documentation

50

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 instructions9pt45

README documents how to install the project.

README12pt48

README is present.

License6pt100

Licensed under BSD-3-Clause.

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/ci.yaml).

Tests18pt80

Test files detected (hyprtester/src/tests).

Issue and PR templates6pt100

Issue or PR templates present.

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 files34 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yaml).
    Good: Issue or PR templates present.
  • assets
  • debug-tools
  • docs
  • example
  • hyprctl
  • hyprpm
  • hyprtester
    Good: Test files detected (hyprtester/src/tests).
  • meta
  • nix
  • protocols
  • scripts
  • src
  • start
  • subprojects
  • systemd
  • tests
  • .clang-format
  • .clang-format-ignore
  • .clang-tidy
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • AGENTS.md
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • flake.lock
  • flake.nix
  • hyprland.pc.in
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • Makefile
  • README.md
    Good: README is present.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.
  • VERSION