Skip to content

docs: document change file comment format #7626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janechu merged 1 commit into from
Jun 26, 2026
Merged

docs: document change file comment format #7626

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/skills/shipping/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,17 @@ npm run change

This walks through the steps to create a change description file that is required for versioning and publishing. The CI gate `npm run checkchange` will fail if a change file is missing for a modified package.

## Change comments

Write the `comment` field as release-note text, not as a commit message. Use a
concise sentence that starts with a capital letter and ends with a period. Do not
prefix comments with conventional commit types such as `fix:`, `feat:`, or
`chore:`.

Beachball uses change-file comments to generate package changelogs and release
notes. Sentence-style comments read cleanly in those user-facing outputs, while
commit-style prefixes duplicate the separate change type metadata and add noise.

## Change types

When prompted, select the appropriate change type:
Expand Down
Loading