google/filament

0

/ 100

Documentation93
Engineering79
Health100
C++20,170Apache-2.05d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Filament is a real-time physically based rendering engine for Android, iOS, Windows, Linux, macOS, and WebGL2

Documentation

93

Contributing guide5pt74

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

79

CI/CD14pt57

CI is configured (.github/workflows/verify-release-notes.yml).

Tests18pt80

Test files detected (filament/backend/test).

Reproducibility6pt92

Lockfile present (build/common/upload-release-assets/package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (android/build.gradle).

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/verify-release-notes.yml).
    Good: Environment pinned via .github/actions/verify-release-notes/Dockerfile.
    Good: Issue or PR templates present.
  • android
    Good: Dependency manifest found (android/build.gradle).
  • art
  • assets
  • build
    Good: Lockfile present (build/common/upload-release-assets/package-lock.json). Installs are reproducible.
  • docs
  • docs_src
  • filament
    Good: Test files detected (filament/backend/test).
  • ide
  • ios
  • libs
  • samples
  • shaders
  • skills
  • test
  • third_party
    Good: Code of conduct present.
    Good: Dependabot is configured. Dependencies update automatically.
    Good: Security policy present.
  • tools
  • web
  • .clang-format
  • .clang-tidy
  • .dir-locals.el
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • build.sh
  • BUILDING.md
  • CMakeLists.txt
  • CODE_STYLE.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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.
    Good: Contributing guide describes code style expectations.
    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.
  • GEMINI.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • NEW_RELEASE_NOTES.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.
    Good: README has code examples.
    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.
  • RELEASE_NOTES.md