Skip to content

docs: document change file comment format#7626

Merged
janechu merged 1 commit into
mainfrom
users/janechu/document-changefile-comment-format
Jun 26, 2026
Merged

docs: document change file comment format#7626
janechu merged 1 commit into
mainfrom
users/janechu/document-changefile-comment-format

Conversation

@janechu

@janechu janechu commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Pull Request

📖 Description

Adds guidance to the shipping skill for Beachball change-file comment formatting.

The new guidance explains that change-file comments are release-note text rather than commit messages, so they should be concise sentence-style comments instead of conventional-commit-prefixed strings.

👩‍💻 Reviewer Notes

This is documentation-only guidance for AI agents and contributors using the FAST shipping skill.

📑 Test Plan

  • git diff --check -- .github/skills/shipping/SKILL.md

✅ Checklist

General

  • I have included a change request file using $ npm run change
  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@janechu janechu merged commit 90a65e9 into main Jun 26, 2026
14 checks passed
@janechu janechu deleted the users/janechu/document-changefile-comment-format branch June 26, 2026 21:34
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.

3 participants