cookiecutter/cookiecutterNew scan
93/ 100 · A

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

A cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects.

Python24,940 starsBSD-3-Clauseupdated 2mo ago
DocumentationREADME, setup, examples, license
96
EngineeringTests, CI, linting, lockfiles
94
Project healthDescription, activity, stars, deps
88

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    Install and run instructions
    DocumentationInfo

    Add a .env.example listing all required environment variables so contributors know what to set up.

Detailed breakdown

Documentation

96
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under BSD-3-Clause.
  • Contributing guide95
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

94
  • Tests100
    • Test files detected (tests).
    • Pytest is fully configured in pyproject.toml with testpaths and test files detected.
    • Coverage reporting is configured in pyproject.toml.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/tests.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • pyproject.toml configures both a formatter/linter (ruff/black) and type checking (mypy).
  • Reproducibility82
    • Lockfile present (uv.lock). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • Dependabot configured for github-actions.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

88
  • Dependency manifest100
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Python.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity80
    • Actively maintained (pushed within 3 months).
    • 24,940 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (tests/test-generate-binaries/input{{cookiecutter.binary_test}}/.DS_Store) (−40 pts).Remove them and add to .gitignore.
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • CHANGELOG
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • cookiecutter
  • docs
  • logo
  • tests
    Good: Test files detected (tests).
    Warning: Build artifacts or local files may be committed (tests/test-generate-binaries/input{{cookiecutter.binary_test}}/.DS_Store) (−40 pts).Fix: Remove them and add to .gitignore.
  • __main__.py
  • .bandit
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml.old
  • .readthedocs.yaml
  • .safety-policy.yml
  • AUTHORS.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • CONTRIBUTING.md
  • justfile
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • Makefile
  • MANIFEST.in
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • 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.
  • SECURITY.md
    Good: Security policy present.
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.