Skip to content

docs: add package name and version formatting to changelog guidelines#33232

Merged
jennifer-shehane merged 1 commit intocypress-io:developfrom
MikeMcC399:issue-32168-contributing-docs-version-refs
Jan 13, 2026
Merged

docs: add package name and version formatting to changelog guidelines#33232
jennifer-shehane merged 1 commit intocypress-io:developfrom
MikeMcC399:issue-32168-contributing-docs-version-refs

Conversation

@MikeMcC399
Copy link
Contributor

@MikeMcC399 MikeMcC399 commented Jan 13, 2026

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.md to standardize version/package references.

  • Adds a Formatting section detailing backtick usage for npm package names, semver versions (X.Y.Z), and ranges (^, ~, comparators)
  • Clarifies that major version numbers (e.g., 15) should not be wrapped in backticks

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-app-bot
Copy link
Collaborator

@MikeMcC399

This comment was marked as outdated.

@jennifer-shehane jennifer-shehane merged commit 301bc75 into cypress-io:develop Jan 13, 2026
15 of 17 checks passed
@MikeMcC399 MikeMcC399 deleted the issue-32168-contributing-docs-version-refs branch January 14, 2026 12:02
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.

Changelog inconsistent version references

3 participants