Contributing to Cookiecutter Hub

July 6, 2026 ยท View on GitHub

Thanks for your interest in contributing! This repository is a hub of examples, documentation, and resources for Cookiecutter.

How to Contribute

Report Issues

  • Open an issue describing the problem or suggestion.
  • Include steps to reproduce if it's a bug.

Add Examples

  1. Create a new directory in examples/ with the format NN-concept/.
  2. Include cookiecutter.json and the {{ cookiecutter.project_name }}/ directory.
  3. Add hooks if relevant.
  4. Update examples/README.md with the new example.
  5. Open a PR.

Improve Documentation

  1. Edit or create files in docs/.
  2. Use clear markdown and code examples.
  3. Keep the existing format and tone.
  4. Open a PR.

Add Resources

  • New templates to resources/awesome-templates.md.
  • Tools to resources/tools-integrations.md.
  • Shortcuts to resources/cheatsheet.md.

Style

  • Language: English for all files.
  • Code: PEP 8 for Python, JSON with 2-space indentation.
  • Commits: Conventional commits (feat:, docs:, fix:, chore:).

Development

git clone https://github.com/MathiasPaulenko/cookiecutter-example.git
cd cookiecutter-example
pip install cookiecutter

# Test examples
cookiecutter examples/01-minimal/
cookiecutter examples/02-hooks/
cookiecutter examples/03-choices-conditionals/
cookiecutter examples/04-dynamic-jinja2/

# Test Behave BDD template
cookiecutter --no-input . project_name=my_behave_project

Repo Structure

docs/          # Documentation
examples/      # Minimalist templates
resources/     # Cheatsheet, links, tools
hooks/         # Behave BDD template hooks
{{ cookiecutter.project_name }}/  # Behave BDD template