Skip to content

docs: clarify change name format#1261

Open
ercanerdogan wants to merge 1 commit into
Fission-AI:mainfrom
ercanerdogan:docs-clarify-change-name-format
Open

docs: clarify change name format#1261
ercanerdogan wants to merge 1 commit into
Fission-AI:mainfrom
ercanerdogan:docs-clarify-change-name-format

Conversation

@ercanerdogan

@ercanerdogan ercanerdogan commented Jun 25, 2026

Copy link
Copy Markdown

This documents the change name validation already enforced by validateChangeName in src/utils/change-utils.ts. The public docs currently show kebab-case examples but do not state that change names must start with a lowercase letter, so names that begin with ticket numbers fail unexpectedly in commands like openspec status --change. This PR clarifies the accepted format and uses a neutral ticket-ID example.

Summary by CodeRabbit

  • Documentation
    • Clarified the required naming format for new change entries.
    • Added rules for valid lowercase kebab-case names, including allowed characters and hyphen placement.
    • Explained how to include an external ticket ID in a change name.

@ercanerdogan ercanerdogan requested a review from TabishB as a code owner June 25, 2026 16:11
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: bc16e49c-b0a8-49c8-a6ec-7dbe1688acc3

📥 Commits

Reviewing files that changed from the base of the PR and between 737518b and d16cfab.

📒 Files selected for processing (1)
  • docs/cli.md

📝 Walkthrough

Walkthrough

The CLI docs now specify the allowed openspec new change name format and show how to prefix a change name with an external ticket ID.

Changes

CLI change-name format

Layer / File(s) Summary
Change name rules
docs/cli.md
Adds lowercase kebab-case rules for openspec new change, including character placement constraints and a ticket-ID-prefixed example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hop through docs with careful glee,
Lowercase paths now guide the tree.
A ticket prefix, neat and bright,
Keeps change names tidy, clean, and right.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation change about validating change name format.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant