flameshot-org/flameshot

0

/ 100

Documentation92
Engineering58
Health68
C++30,174GPL-3.07d ago
Grade a repo

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

Powerful yet simple to use screenshot software :desktop_computer: :camera_flash:

Documentation

92

Contributing guide5pt66

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 GPL-3.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/build_cmake.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 files25 root entries
  • .github
    Good: CI is configured (.github/workflows/build_cmake.yml).
    Good: Issue or PR templates present.
  • cmake
  • data
  • docs
    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.
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • packaging
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .clang-format
  • .clang-tidy
  • .cmake-format.yaml
  • .envrc
  • .gitignore
    Good: .gitignore present.
  • appveyor.yml
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • default.nix
  • flake.lock
  • flake.nix
  • flameshot.example.ini
  • LICENSE
    Good: Licensed under GPL-3.0.
  • PKGBUILD
  • 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.
  • shell.nix
  • snapcraft.yaml