Skip to content

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

pctemplates

Community templates for Plane Compose — the declarative CLI for managing Plane projects as code.

Use these templates with plane init --template to bootstrap new projects with a proven folder layout, states, labels, and feature configuration already in place.


Usage

# Minimal starter
plane init MYPROJ -w myteam --template https://github.com/mguptahub/pctemplates/templates/template-v1

# Full-featured (pages, views, epics, custom types & workflows)
plane init MYPROJ -w myteam --template https://github.com/mguptahub/pctemplates/templates/template-v2

Replace MYPROJ with your project key and myteam with your workspace slug.


Templates

Template Best for Features enabled
template-v1 Small teams, quick start None — minimal setup
template-v2 Product & software teams Pages, Views, Epics, Custom Types, Workflows

template-v1 — Minimal Starter

A lean, no-frills starting point. All optional features are off so you only add what your team actually needs.

Features: all disabled by default (cycles, modules, pages, views, intakes, epics, custom types, workflows)

States:

State Group Default
Backlog backlog
BA Review backlog
Ready unstarted
In Progress started
In Review started
Testing started
Release Pending completed
Done completed
Cancelled cancelled

Labels: Frontend · Backend · Infrastructure · Documentation

What's included:

schema/
  features.yaml       — all features off (toggle what you need)
  states.yaml         — 9 states covering a basic dev lifecycle
  labels.yaml         — 4 general-purpose labels
  types.yaml          — empty; add custom types as needed
  workflows.yaml      — empty; add custom workflows as needed
  members.yaml        — empty
work/
  workitems.yaml      — empty; add work items and run plane push
  cycles.yaml         — empty
  modules.yaml        — empty

Use when: You want to get started quickly and prefer to enable features manually as the team grows.


template-v2 — Full-Featured

A richer template for product and software teams that need hierarchy, wiki pages, saved views, and structured workflows from day one.

Features:

Feature Enabled
Cycles
Modules
Pages
Views
Intakes
Epics
Custom Work Item Types
Workflows

States:

State Group
Icebox backlog
Backlog backlog
Ready unstarted
In Progress started
In Review started
Testing started
Done completed
Cancelled cancelled

Labels: Frontend · Backend · Infrastructure · Documentation

What's included:

schema/
  features.yaml       — pages, views, epics, custom types, workflows ON
  states.yaml         — 8 states including Icebox
  labels.yaml         — 4 general-purpose labels
  types.yaml          — empty; ready for custom type definitions
  workflows.yaml      — empty; ready for custom workflow definitions
  members.yaml        — empty
work/
  workitems.yaml      — empty
  cycles.yaml         — empty
  modules.yaml        — empty

Use when: Your team writes specs/RFCs (pages), tracks epics, or needs structured workflows with transition rules.


Folder Structure

Every template follows the standard Plane Compose layout:

template-name/
├── schema/               ← Settings-layer config (rarely changes)
│   ├── features.yaml     — toggle project features on/off
│   ├── states.yaml       — work item states
│   ├── labels.yaml       — label definitions
│   ├── types.yaml        — custom work item types + properties
│   ├── workflows.yaml    — state machine workflows
│   └── members.yaml      — project members (read-only reference)
└── work/                 ← Operational data (changes frequently)
    ├── workitems.yaml    — work items (push with `plane push`)
    ├── cycles.yaml       — sprint / cycle definitions
    └── modules.yaml      — module / feature area definitions

schema/ vs work/: schema/ mirrors the Plane Settings tab — it defines how the project works.
work/ mirrors the Plane Details tab — it holds the actual work.


After Initialising

# 1. Review and adjust feature flags
vim schema/features.yaml

# 2. Push schema to Plane (creates states, labels, etc.)
plane schema push

# 3. Add work items
vim work/workitems.yaml

# 4. Push work items
plane push

Creating Your Own Template

  1. Fork this repo (or create a new one)
  2. Copy one of the existing templates as a starting point:
    cp -r templates/template-v1 templates/my-template
  3. Edit the YAML files to match your team's conventions
  4. Use it:
    plane init MYPROJ -w myteam --template https://github.com/your-org/your-repo/templates/my-template

Templates also work from SSH URLs and local paths:

# SSH
plane init MYPROJ -w myteam --template git@github.com:your-org/your-repo.git/templates/my-template

# Local
plane init MYPROJ -w myteam --template ./templates/my-template

Contributing

Pull requests welcome. If you've set up a template for a specific use case (agency workflow, open-source project, mono-repo, etc.), feel free to add it.

Please follow the folder naming convention templates/<name>/ and include comments in each YAML file explaining any non-obvious choices.

About

Plane Compose Templates

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors