// Creates commits following the monorepo's Conventional Commits standard with proper GPG signing, scope selection, and pre-commit validation. Reminds about changesets for package changes. Use when creating commits, writing commit messages, or when the user asks to commit changes.
| name | commit |
| description | Creates commits following the monorepo's Conventional Commits standard with proper GPG signing, scope selection, and pre-commit validation. Reminds about changesets for package changes. Use when creating commits, writing commit messages, or when the user asks to commit changes. |
This skill guides committing changes following the project's Conventional Commits standard.
main - Always check the current branch before committing. If on main, create a new branch first (see Commit Workflow below).--no-gpg-sign - All commits must be GPG-signed--no-verify - Pre-commit hooks must run<type>(<scope>): <subject>
[optional body]
[optional footer(s)]
| Rule | Requirement |
|---|---|
| Header max length | 100 characters |
| Subject case | lowercase (never sentence-case, start-case, pascal-case, upper-case) |
| Subject ending | No period |
| Scope | Required (scope-empty is enforced) |
| Body line length | Max 100 characters |
| Body leading blank | Required if body present |
| Type | Description |
|---|---|
feat | New feature |
fix | Bug fix |
docs | Documentation only |
style | Formatting, whitespace (no code change) |
refactor | Code change that neither fixes a bug nor adds a feature |
perf | Performance improvement |
test | Adding or correcting tests |
build | Build system or external dependencies |
ci | CI configuration changes |
chore | Other changes (not src or test) |
revert | Reverts a previous commit |
wip | Work in progress (avoid if possible) |
The commitlint config enforces these scopes:
| Scope | Description |
|---|---|
types | Type definitions package |
utils | Utility functions package |
styles | Styles package |
components | Components package |
renderer | Renderer package |
react | React integration package |
storage | Storage package |
deps | Dependencies |
config | Configuration files |
ci | CI/CD configuration |
docs | Documentation |
tests | Test-related changes |
release | Release automation |
examples | Example applications |
common | Common/shared code |
spec | Specification documents |
# 1. Stage changes
git add <files>
# 2. Commit with HEREDOC (recommended for multi-line messages)
git commit -m "$(cat <<'EOF'
feat(components): add new contract widget
Implements a reusable widget component for displaying
contract state with real-time updates.
EOF
)"
Before committing changes to packages/ directory, check if a changeset is needed.
A changeset is required when:
Check for existing changesets:
ls .changeset/*.md
If no changeset exists for your changes, create one:
pnpm changeset
Published packages in this monorepo:
@openzeppelin/ui-types@openzeppelin/ui-utils@openzeppelin/ui-styles@openzeppelin/ui-components@openzeppelin/ui-renderer@openzeppelin/ui-react@openzeppelin/ui-storageThe following checks run automatically on commit:
pnpm format:checkIf pre-commit fails, fix the issues and commit again.
Before pushing, these checks run:
pnpm fix-allpnpm typecheckpnpm testIf pre-push fails, fix the issues and push again.
Indicate breaking changes with ! after type/scope:
feat(types)!: change network config interface
Or with a footer:
feat(types): change network config interface
BREAKING CHANGE: NetworkConfig interface now requires chainId property.
All consumers must update their configuration.
Symptom: Commit fails with permission errors, GPG signing fails, or hooks don't run.
Fix: Run commit commands with full shell permissions (outside sandbox).
Symptom: scope-enum error from commitlint.
Fix: Use one of the allowed scopes above. If a new scope is justified, update commitlint.config.js.
Symptom: subject-case error.
Fix: Use lowercase for the entire subject:
Add new featureadd new featureSymptom: scope-empty error from commitlint.
Fix: Always include a scope. Choose the most relevant package or category.
# Feature with package scope
feat(components): add network badge component
# Fix with package scope
fix(utils): correct address validation for checksums
# Refactor with package scope
refactor(renderer): simplify form field rendering logic
# Specification documents
docs(spec): add data model for extend example apps feature
# Documentation
docs(examples): add wallet connection tutorial
# Test changes
test(react): add unit tests for useWalletComponents hook
# Dependencies update
chore(deps): update vitest to v3.2.4
# CI changes
ci(config): add coverage threshold checks
# Release automation (auto-generated, usually ignored by commitlint)
chore(release): version packages
# Stage and commit
git add . && git commit -m "feat(components): add feature"
# Check commit format is valid
echo "feat(components): add feature" | npx commitlint
# View recent commit formats for reference
git log --oneline -10
# Amend last commit (only if not pushed!)
git commit --amend
# Create changeset for package changes
pnpm changeset