docs: add package name and version formatting to changelog guidelines#33232
Merged
jennifer-shehane merged 1 commit intocypress-io:developfrom Jan 13, 2026
Conversation
Collaborator
|
This comment was marked as outdated.
This comment was marked as outdated.
jennifer-shehane
approved these changes
Jan 13, 2026
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
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.
Additional details
Situation
Unclear documentation for formatting version references leads to inconsistent formatting of some aspects of the CHANGELOG.md which is sourced into the published changelog website reference page.
Change
Add to the contributor's reference guide Cypress App - Managing the Release Changelog:
Note
Introduces explicit formatting guidance in
guides/writing-the-cypress-changelog.mdto standardize version/package references.npmpackage names,semverversions (X.Y.Z), and ranges (^,~, comparators)Written by Cursor Bugbot for commit af05d5a. This will update automatically on new commits. Configure here.
Steps to test
Documentation change only.
How has the user experience changed?
Only relevant for contributors.
PR Tasks
cypress-documentation?type definitions?