Skip to content

docs: fix typo in contributing guide #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2025

Conversation

massrain
Copy link
Contributor

@massrain massrain commented Jul 3, 2025

Description

Correct a typo in docs/G_UpgradeToV5.mdx.

  • Before: customSquareStyles → squareStyle
  • After: customSquareStyles → squareStyles

The issue:
customSquareStyles (v4) maps directly to squareStyles (object-based styling) in v5, whereas squareStyle is a different, function-based prop. Updating the guide prevents confusion for users migrating from v4 to v5.

Type of change

  • Documentation update

Checklist

  • My change follows the style guidelines of this project
  • I performed a self-review of my changes
  • Documentation builds without warnings
  • No code changes required

Copy link

vercel bot commented Jul 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-chessboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 3, 2025 0:43am

@Clariity Clariity merged commit 7ca82c3 into Clariity:main Jul 3, 2025
2 checks passed
@Clariity
Copy link
Owner

Clariity commented Jul 3, 2025

great catch, thank you

Copy link

github-actions bot commented Jul 7, 2025

🎉 This PR is included in version 5.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants