Skills template-authoring
install
source · Clone the upstream repo
git clone https://github.com/dotnet/skills
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/dotnet/skills "$T" && mkdir -p ~/.claude/skills && cp -r "$T/plugins/dotnet-template-engine/skills/template-authoring" ~/.claude/skills/dotnet-skills-template-authoring && rm -rf "$T"
manifest:
plugins/dotnet-template-engine/skills/template-authoring/SKILL.mdsource content
Template Authoring
This skill helps an agent create and validate custom
dotnet new templates. It guides bootstrapping templates from existing projects and validates template.json files for authoring issues before publishing.
When to Use
- User wants to create a reusable template from an existing .csproj
- User wants to validate a template.json for correctness
- User is setting up
from scratch.template.config/template.json - User wants to package a template for NuGet distribution
When Not to Use
- User wants to find or use existing templates — route to
ortemplate-discoverytemplate-instantiation - User has MSBuild issues unrelated to template authoring — route to
plugindotnet-msbuild
Inputs
| Input | Required | Description |
|---|---|---|
| Source project path | For creation | Path to the .csproj to use as template source |
| template.json path | For validation | Path to an existing template.json to validate |
| Template name | For creation | Human-readable name for the template |
| Short name | Recommended | Short name for usage |
Workflow
Step 1: Bootstrap from existing project
Analyze the source
.csproj and create a .template.config/template.json:
- Create
directory next to the project.template.config - Generate
withtemplate.json
(reverse-DNS),identity
,name
,shortName
(project name for replacement),sourceName
, andclassificationstags - Preserve from source: SDK type, package references with metadata (PrivateAssets, IncludeAssets), properties (OutputType, TreatWarningsAsErrors), CPM patterns
Minimal example:
{ "$schema": "http://json.schemastore.org/template", "author": "MyOrg", "classifications": ["Library"], "identity": "MyOrg.Templates.MyLib", "name": "My Library Template", "shortName": "mylib", "sourceName": "MyLib", "tags": { "language": "C#", "type": "project" } }
Step 2: Validate template.json
Read and review the
template.json for common authoring issues:
Validation checks to perform:
- Required fields — verify
,identity
, andname
are presentshortName - Identity format — use reverse-DNS format (e.g.,
)MyOrg.Templates.WebApi - Parameter issues — check datatypes are valid (
,string
,bool
,choice
,int
), choices have defaults, descriptions are presentfloat - ShortName conflicts — avoid names that collide with built-in CLI commands (
,build
,run
,test
). Check withpublish
to see if the name is already takendotnet new list - Post-action completeness — verify post-actions have all required configuration
- Tags — ensure language, type, and classification tags are set for discoverability
Step 3: Refine the template
Based on validation results and user requirements:
- Add parameters with appropriate types (string, bool, choice), defaults, and descriptions
- Add conditional content using
preprocessor directives for optional features#if - Configure post-actions for solution add, restore, or custom scripts
- Set constraints to restrict which SDKs or workloads the template supports
- Add classifications and tags for discoverability
Step 4: Test the template locally
dotnet new install ./path/to/template/root dotnet new mylib --name TestProject --dry-run dotnet new mylib --name TestProject --output ./test-output dotnet build ./test-output/TestProject
Validation
-
passes manual validation with zero errorstemplate.json - Template identity and shortName are unique and meaningful
- All parameters have descriptions and appropriate defaults
- Template can be installed, dry-run, and instantiated successfully
- Created projects build cleanly with
dotnet build - Conditional content produces correct output for all parameter combinations
Common Pitfalls
| Pitfall | Solution |
|---|---|
| Identity format issues | Use reverse-DNS format (e.g., ). Avoid spaces or special characters. |
| ShortName conflicts with CLI commands | Avoid names like , , , . Check by running to see if the name is already taken. |
| Missing parameter descriptions | Every parameter should have a and for discoverability. |
| Not testing all parameter combinations | Use with different parameter values to verify conditional content works correctly. |
| Hardcoded versions in template | Use replacement for project names and consider parameterizing framework versions. |
| Not setting classifications | Add appropriate (e.g., ) for template discovery. |
More Info
- Custom templates for dotnet new — official authoring guide
- template.json reference — full schema reference
- Template Engine Wiki — template engine internals