Skip to content

docs(release-scm): fix setup-cz link - #2052

Open
Lee-W wants to merge 1 commit into
masterfrom
docs/fix-setup-cz-link
Open

docs(release-scm): fix setup-cz link#2052
Lee-W wants to merge 1 commit into
masterfrom
docs/fix-setup-cz-link

Conversation

@Lee-W

@Lee-W Lee-W commented Aug 5, 2026

Copy link
Copy Markdown
Member

Description

The setup-cz link in docs/tutorials/release-scm.md was missing the https:// scheme (it read github.com/commitizen-tools/setup-cz), so it rendered as a broken/relative link instead of a working hyperlink. This adds the full scheme.

Checklist

Was generative AI tooling used to co-author this PR?

  • Yes (please specify the tool below)

Code Changes

Not applicable — documentation-only change, no code modified.

  • Add test cases to all the changes you introduce
  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external)

Expected Behavior

In docs/tutorials/release-scm.md, the setup-cz link inside the "Wrap this in a CI job…" tip block renders as a clickable hyperlink pointing to https://github.com/commitizen-tools/setup-cz.
In docs/tutorials/release-scm.md, the setup-cz link inside the "Wrap this in a CI job…" tip block renders as a clickable hyperlink pointing to https://github.com/commitizen-tools/setup-cz.

Steps to Test This Pull Request

  1. Run uv run poe doc to build the docs site locally
  2. Open the tutorials/release-scm.md page and find the tip block just above "Why Can't I Bump with SCM?"
  3. Confirm the setup-cz link is clickable and resolves to https://github.com/commitizen-tools/setup-cz

Additional Context

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🔍 Commitizen bump preview

No commits in this PR are eligible for a version bump.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant