Update CHANGELOG.md files based on changes made in the current branch. Use when the user asks to update changelogs, document changes, or prepare release notes.
Update CHANGELOG.md files to reflect changes made in the current git branch.
Run these git commands to understand what changed:
# Get the base branch (usually master or main)
git log --oneline -1 origin/master
# List all commits in current branch not in master
git log origin/master..HEAD --oneline
# Show changed files with their packages
git diff origin/master --name-only
Determine which packages were modified by checking changed file paths:
packages/react/src/atomic/<Component>/* → Update packages/react/src/atomic/<Component>/CHANGELOG.md and packages/react/CHANGELOG.mdpackages/react/src/composite/<Component>/* → Update packages/react/src/composite/<Component>/CHANGELOG.md packages/react/CHANGELOG.mdpackages/core/styles/* → Update packages/core/styles/CHANGELOG.mdpackages/core/tokens/* → Update packages/core/tokens/CHANGELOG.mdCHANGELOG.mdCRITICAL After ANY change to a specific component, it's critical to reflect the same change in packages/react/CHANGELOG.md. If this is ommited, the change will only apply to the specific package and not to the general @nimbus-ds/components bundle, generating an inconsistency.
Determine the change type based on commit messages and diff:
| Type | Category | Version Bump |
|---|---|---|
| Breaking API changes | 🛠 Breaking changes | Major (x.0.0) |
| New props, components, features | 🎉 New features | Minor (0.x.0) |
| Bug fixes, corrections | 🐛 Bug fixes | Patch (0.0.x) |
| Dependency updates | 📚 3rd party library updates | Patch |
| Refactors, docs, tooling | 💡 Others | Patch |
Format:
## YYYY-MM-DD `version`
#### <emoji> <category>
- <Summary of the change>. ([#PR](https://github.com/TiendaNube/nimbus-design-system/pull/PR) by [@contributor](https://github.com/contributor))
Writing Guidelines:
Good examples:
Added disabled state styling to Input component.Fixed focus ring not appearing on keyboard navigation.Updated Button to support icon-only variant.Bad examples:
Update Input.tsx to add handleFocus callback and modify CSS classes.Fixes bug in line 45 of nimbus-input.css.ts where outline was missing.If any of the following is unknown, ask the user:
# Changelog headerFull formatting rules are defined in .cursor/rules/changelogs.mdc.