Contributing to Tabler

Thank you for wanting to contribute! This is a short overview - the full guide lives in the documentation: How to Contribute.

Quick start

Requirements: Node.js 22.12+ and pnpm.

pnpm install
pnpm run dev

This starts the preview website at http://localhost:3000 and the documentation at http://localhost:3010, both with live reload.

core/ - the framework: SCSS (core/scss/) and JavaScript (core/js/)
preview/ - demo website (Astro, pages in preview/pages/*.astro)
docs/ - documentation website (Astro, pages in docs/pages/**/*.mdx)
shared/ - components and layouts shared by preview and docs (@shared alias), plus data/ and static/
shared/data/ - JSON data for demo pages (@data alias)

Do not edit dist/ folders - they are generated by the build.

Branch off dev and use the branch naming convention: <type>/<short-description>, for example feat/gh-123-add-stepper-component or fix/markdown-table-overflow. Allowed types: feat, fix, docs, chore, refactor, test, build, ci, perf, style, revert.
Build and test: pnpm run build must pass. For docs changes, also run pnpm run lint.
Add a changeset if your change affects any package: pnpm exec changeset. Use one sentence starting with Added, Updated, Fixed or Removed, with backticks for code tokens (for example Added `.btn-ghost` variant for buttons.).
Write the PR in English: a concise title in present tense (max ~72 chars, no trailing period) and a short description that explains why the change is needed.

Use Bootstrap 5 conventions and Tabler's CSS custom properties pattern: --#{$prefix}component-property.
Write documentation in simple English: short sentences, common words, direct instructions.
Ensure changes work in all supported browsers (see the browser support docs).

By participating, you agree to follow our Code of Conduct.