From d16cfab596db7922c03c297488c190eab32b3fd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ercan=20Erdo=C4=9Fan?= Date: Thu, 25 Jun 2026 18:01:41 +0200 Subject: [PATCH] docs: clarify change name format --- docs/cli.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/cli.md b/docs/cli.md index 8f9c03bae..e9845da4b 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -620,6 +620,13 @@ Create a change directory and optional checked-in metadata in the resolved OpenS openspec new change [options] ``` +Change names must use lowercase kebab-case. They start with a lowercase letter, +then contain lowercase letters, numbers, and single hyphens. They cannot start +with a number, contain spaces, underscores, uppercase letters, consecutive +hyphens, or leading/trailing hyphens. When including an external ticket ID, +prefix it with a word, for example `ticket-123-add-notifications` instead of +`123-add-notifications`. + **Options:** | Option | Description |