serenityos/serenity

0

/ 100

Documentation65
Engineering67
Health100
C++33,498BSD-2-Clause5d ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

The Serenity Operating System 🐞

Documentation

65

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt85

README is present.

Contributing guide5pt92

Contributing guide is detailed and thorough.

License6pt100

Licensed under BSD-2-Clause.

Engineering

67

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

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

Tests18pt80

Test files detected (Base/home/anon/Tests).

Reproducibility6pt92

Lockfile present (Tests/ClangPlugins/requirements.txt). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Tests/ClangPlugins/requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files30 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for github-actions.
  • AK
  • Base
    Good: Test files detected (Base/home/anon/Tests).
  • Documentation
  • Kernel
  • Ladybird
  • Meta
  • Ports
  • Tests
    Good: Lockfile present (Tests/ClangPlugins/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (Tests/ClangPlugins/requirements.txt).
  • Toolchain
    Good: Environment pinned via Toolchain/Dockerfile.
  • Userland
  • .clang-format
  • .clang-tidy
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gn
  • .mailmap
  • .pre-commit-config.yaml
  • .prettierignore
  • .prettierrc
  • .ycm_extra_conf.py
  • CMakeLists.txt
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • flake.lock
  • flake.nix
  • LICENSE
    Good: Licensed under BSD-2-Clause.
  • 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.
    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.
  • SECURITY.md
    Good: Security policy present.