Skip to content

Bug fix

Vittorio Vittori edited this page Jul 8, 2026 · 1 revision

Bug fix

The least impactful contribution: correcting unexpected behaviour in a component or a published node package.

When to use this

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.

At a glance

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.

Flow

1. Propose

  • 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.

2. Code

  • Create a branch (naming follows the fix type in commitlint.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.

3. Submit

  • Open a Pull Request to dev, linking the issue.

Checkpoint — Core team review & merge.

4. Doc (only if the fix changes documented behaviour)

  • Update the relevant documentation.

5. Release

  • Handled by the core team — typically a patch release.

Step descriptions: Steps reference. Questions: Stack Overflow.

Clone this wiki locally