Repository navigation
Bug fix
The least impactful contribution: correcting unexpected behaviour in a component or a published node package.
Use a bug fix when something already shipped doesn't work as documented — a wrong event, a broken style, an incorrect value. If your change adds behaviour rather than restoring it, it's an enhancement instead — see Small enhancement or Large enhancement.
| Design | Code | Doc | Checkpoints | Typical release |
|---|---|---|---|---|
| — | ✓ | if the fix changes documented behaviour | triage → review & merge | patch |
A bug fix normally skips Design: you're restoring intended behaviour, not designing new UI. It therefore has two checkpoints, not three.
- Check existing issues — the bug may already be reported.
- Open a Bug report: steps to reproduce, expected vs actual, affected package.
Checkpoint — Core team triage. The core team confirms the bug, sets the type/labels/milestone, or asks for more detail.
- Create a branch (naming follows the
fixtype incommitlint.config.js). - Fix the code; keep the change minimal and scoped to the defect.
- Reproduce the fix in Storybook (visual + a11y addon).
- Add or adjust a unit/functional test that fails before the fix and passes after.
- Verify supported browsers/devices.
- Write the changelog entry.
- Open a Pull Request to
dev, linking the issue.
Checkpoint — Core team review & merge.
- Update the relevant documentation.
- Handled by the core team — typically a patch release.
Step descriptions: Steps reference. Questions: Stack Overflow.
Magma Design System - Maggioli. This wiki is maintained by the community; spot something wrong? Open a Documentation issue.