Getting started

Requirements

Install Git, Docker Desktop, Visual Studio Code, and the Dev Containers extension. Start Docker Desktop before opening the project. On Windows, use Docker Desktop with its WSL 2 backend.

Create your repository

Select Use this template and create a repository.
Clone the new repository and open it in Visual Studio Code.
Run Dev Containers: Reopen in Container from the Command Palette.
Wait for setup to install the declared tools and configure Git hooks.
Initialize a root package or Cargo workspace.

Tools and workflows

The Dev Container provides a Linux development environment across Windows, macOS, and Linux hosts. Mise declares the project tools and provides tasks for running them.

Rust uses the default profile, including rustfmt, Clippy, and local Rust docs.
uv runs Python tools, including Commitizen and Zensical.
The project entry script configures Git hooks and Commitizen.
prek runs repository checks locally and in the pull-request quality gate.
rumdl and ShellCheck check Markdown and shell scripts.
Tombi formats TOML configuration files locally and in CI through the tombi-format hook.
Git attributes and ignore rules handle Rust source and build artifacts.
Zensical publishes developer documentation.
Dependabot updates GitHub Actions dependencies.
Issue forms, contribution guidance, security reporting, and code ownership support repository maintenance.

Verify the environment

mise doctor
mise ls --current
prek run --all-files

The template's CI checks repository files. Add Rust checks after initializing your Cargo project, following the Rust project setup guide.

Format TOML

tombi format --offline
tombi format --offline --check

The formatter uses tombi.toml, excludes generated Cargo and Mise lockfiles, and runs without schema lookups. The pre-commit hook pins its own Tombi version so local hooks and CI use the same formatter.

Preview documentation

mise run docs

See the contribution guide for the complete contribution workflow.