catchorg/catch2

0

/ 100

Documentation83
Engineering58
Health68
C++20,456BSL-1.010d ago
Grade a repo

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

A modern, C++-native, test framework for unit-tests, TDD and BDD - using C++14, C++17 and later (C++11 support is in v2.x branch, and C++03 on the Catch1.x branch)

Documentation

83

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt93

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under BSL-1.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/linux-bazel-builds.yml).

Tests18pt80

Test files detected (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
  • .conan
  • .github
    Good: CI is configured (.github/workflows/linux-bazel-builds.yml).
    Good: Issue or PR templates present.
  • benchmarks
  • CMake
  • data
  • docs
    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.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • examples
  • extras
  • fuzzing
  • src
  • tests
    Good: Test files detected (tests).
  • third_party
  • tools
  • .bazelrc
  • .clang-format
  • .clang-tidy
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • appveyor.yml
  • BUILD.bazel
  • CMakeLists.txt
  • CMakePresets.json
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • conanfile.py
  • Doxyfile
  • LICENSE.txt
    Good: Licensed under BSL-1.0.
  • MAINTAINERS.md
  • mdsnippets.json
  • meson_options.txt
  • meson.build
  • MODULE.bazel
  • 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.
    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.