eblume/project-template
Template
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A personal project template with opinionated infrastructure for documentation, CI, and AI-assisted development.
3 commits 1 branch 0 tags 157 KiB
  • Python 57.7%
  • Shell 42.3%
Find a file Use this template
Erich Blume 5c9f06c165 Add README and ensure TODO markers at all template customization points 
Adds a README.md describing the template and how to fork it. Adds TODO
comments to Dagger config, Quartz config, and CI workflow where they
were missing. Adds a "First-Time Setup" section to CLAUDE.md that
instructs Claude to proactively suggest resolving TODOs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-03 19:25:14 -08:00
.dagger Add README and ensure TODO markers at all template customization points 2026-03-03 19:25:14 -08:00
.forgejo/workflows Add README and ensure TODO markers at all template customization points 2026-03-03 19:25:14 -08:00
.github Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00
docs Add README and ensure TODO markers at all template customization points 2026-03-03 19:25:14 -08:00
mise-tasks Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00
.gitignore Add .ruff_cache to gitignore 2026-03-03 19:09:53 -08:00
.yamllint.yaml Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00
CHANGELOG.md Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00
CLAUDE.md Add README and ensure TODO markers at all template customization points 2026-03-03 19:25:14 -08:00
dagger.json Add README and ensure TODO markers at all template customization points 2026-03-03 19:25:14 -08:00
mise.toml Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00
prek.toml Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00
README.md Add README and ensure TODO markers at all template customization points 2026-03-03 19:25:14 -08:00
towncrier.toml Initial scaffold (pre-hook install) 2026-03-03 19:05:51 -08:00

README.md

project-template

A personal project template with opinionated infrastructure for documentation, CI, and AI-assisted development.

What's Included

  • Documentation — Diataxis-structured docs built with Quartz
  • Changelog — Towncrier fragment-based changelog
  • CI/CD — Dagger pipelines + Forgejo Actions workflow for releases
  • Pre-commit hooks — prek with linting, formatting, secret detection
  • AI assistance — CLAUDE.md + structured docs for Claude Code (C0/C1/C2 change process, Mikado method)
  • Task runner — mise tasks for docs validation, Mikado chain management, and more

Forking This Template

The template contains TODO markers at every point that needs customization. To set up a new project:

  1. Fork or copy this repository
  2. Search for TODO across all files — each one marks a value you need to update:
    • Project name and description (CLAUDE.md, docs/index.md)
    • Forgejo/forge instance URLs (build.yaml, mise-tasks/docs-mikado, mise-tasks/pr-comments)
    • Dagger module name and class (dagger.json, .dagger/)
    • Quartz site title and URLs (docs/quartz.config.ts, docs/quartz.layout.ts)
    • CI git identity (.forgejo/workflows/build.yaml)
  3. Rename the .dagger/src/project_template_ci/ directory to match your new Dagger module name
  4. Remove the "First-Time Setup" section from CLAUDE.md once all TODOs are resolved
  5. Delete this "Forking This Template" section from README.md and write your own project description

If you use Claude Code, it will prompt you to resolve these TODOs at the start of your first session.

Getting Started

# Install git hooks
prek install && prek install --hook-type commit-msg

# Run all pre-commit checks
prek run --all-files

# List available tasks
mise tasks

# Build docs (requires Dagger)
dagger call build-docs --src=. --version=dev export --path=./docs-dev.tar.gz

Project Structure

./docs/                 # documentation (Diataxis, Quartz)
./docs/changelog.d/     # towncrier fragments
./.dagger/              # dagger pipelines
./.forgejo/             # forgejo-runner actions and workflows
./mise-tasks/           # scripts via `mise run`

License