docs: document breaking change convention and release category#399
Merged
docs: document breaking change convention and release category#399
Conversation
- add Breaking Changes category to release notes docs - document ! breaking change indicator in developer-workflows.md - add [Type] Breaking Change row to automatic labeling table Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
bot
added
the
[Type] Developer Documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Fixes two documentation gaps identified in #392 (comment) as a follow-up to #392.
Why?
The docs were inconsistent with the actual configuration and labeling behavior introduced in #392:
docs/releases.mdlisted only three release categories, omitting "Breaking Changes"docs/code/developer-workflows.mdhad no mention of the!breaking change convention or[Type] Breaking ChangelabelHow?
docs/releases.md: Added "Breaking Changes" as the first release category, and noted which labels are excluded from "Other Changes"docs/code/developer-workflows.md: Updated the commit format to include the optional!indicator with examples, and added[Type] Breaking Changeto the automatic labeling tableTesting Instructions
Documentation-only change — verify the rendered markdown looks correct.
Accessibility Testing Instructions
N/A — no UI changes.