k4yt3x/video2x

0

/ 100

Documentation88
Engineering30
Health58
C++20,299AGPL-3.03mo ago
Grade a repo

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

A machine learning-based video super resolution and frame interpolation framework. Est. Hack the Valley II, 2018.

Documentation

88

Contributing guide5pt77

Contributing guide is detailed and thorough.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under AGPL-3.0.

Engineering

30

Tests18pt0

No tests detected anywhere in the repository.

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

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.

Reproducibility6pt10

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/build.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

58

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.

Activity5pt60

Last pushed 3-6 months ago (−40 pts). A push within 90 days earns 80 pts; within 30 days earns 100 pts.

→ A recent commit keeps the project looking alive to visitors and contributors.

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files24 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • cmake
  • docs
  • include
  • models
  • packaging
    Good: Environment pinned via packaging/docker/Dockerfile.
  • scripts
  • src
  • third_party
  • tools
  • .clang-format
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .justfile
  • CHANGELOG.md
  • CITATION.cff
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    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.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • NOTICE
  • 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.