docs: clarify change name format#1261
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe CLI docs now specify the allowed ChangesCLI change-name format
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
TabishB
left a comment
There was a problem hiding this comment.
Thanks for the clarification. We should try and loosen the requirements here I suppose. Any valid fs name should be ok.
Agree. As you suggested, we can relax this validation to allow numbers. I can open a follow-up PR for that as well. |
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