mirror of
https://github.com/tabler/tabler.git
synced 2026-08-29 13:21:29 +04:00
65 lines
4.6 KiB
Markdown
65 lines
4.6 KiB
Markdown
# Contributing to Tabler
|
|
|
|
Thank you for wanting to contribute! This is a short overview — the full guide lives in the documentation: [How to Contribute](https://docs.tabler.io/ui/getting-started/how-to-contribute/).
|
|
|
|
## Ways to contribute
|
|
|
|
- **Pick a starter issue** — issues labeled [`good first issue`](https://github.com/tabler/tabler/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) are small and well-scoped, and [`help wanted`](https://github.com/tabler/tabler/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues welcome community help.
|
|
- **Report a bug** — use the [bug report template](https://github.com/tabler/tabler/issues/new?template=bug_report.yml). Include steps to reproduce and, if possible, a live example (for example a JSFiddle).
|
|
- **Suggest a feature** — use the [feature request template](https://github.com/tabler/tabler/issues/new?template=feature_request.yml) or start a [discussion](https://github.com/tabler/tabler/discussions) first if you are not sure.
|
|
- **Improve the documentation** — docs live in `docs/pages/**/*.mdx` and follow the same pull request workflow as code.
|
|
- **Submit a pull request** — fixes and improvements are always welcome. For large changes, please open an issue or discussion first so we can align before you invest time.
|
|
- **Report a security issue** — do not open a public issue; follow the [security policy](SECURITY.md) instead.
|
|
|
|
## Quick start
|
|
|
|
Requirements: Node.js 22.12+ and [pnpm](https://pnpm.io/).
|
|
|
|
```sh
|
|
pnpm install
|
|
pnpm run dev
|
|
```
|
|
|
|
This starts the preview website at [http://localhost:3000](http://localhost:3000) and the documentation at [http://localhost:3010](http://localhost:3010), both with live reload.
|
|
|
|
You can also skip the local setup entirely: open the repository in [GitHub Codespaces](https://codespaces.new/tabler/tabler) or a VS Code Dev Container — the configuration in `.devcontainer/` installs Node.js, pnpm and all dependencies for you.
|
|
|
|
## Where things live
|
|
|
|
- `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.
|
|
|
|
## Useful commands
|
|
|
|
| Command | What it does |
|
|
| -------------------- | ----------------------------------------------------- |
|
|
| `pnpm run dev` | Start preview and docs dev servers with live reload |
|
|
| `pnpm run build` | Production build of all packages |
|
|
| `pnpm run lint` | Markdown, Prettier and SCSS variable checks |
|
|
| `pnpm run lint:fix` | Auto-fix lint issues where possible |
|
|
| `pnpm run test` | Run the test suites |
|
|
| `pnpm run check` | Lint plus TypeScript type checks |
|
|
|
|
## Before you open a pull request
|
|
|
|
1. **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`.
|
|
2. **Build and test**: `pnpm run build` must pass. For docs changes, also run `pnpm run lint`.
|
|
3. **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. ``).
|
|
4. **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.
|
|
5. **Keep the scope small**: one logical change per pull request makes reviews faster and releases safer.
|
|
|
|
## Code style
|
|
|
|
- Use Bootstrap 5 conventions and Tabler's CSS custom properties pattern: `--component-property`. Write custom properties without a prefix — the build adds the public `--tblr-` prefix. Names owned by a third-party library you are theming must be listed in `cssVarIgnore` in `.build/css-var-prefix.ts` so they stay untouched.
|
|
- Write documentation in simple English: short sentences, common words, direct instructions.
|
|
- Ensure changes work in all supported browsers (see the [browser support docs](https://docs.tabler.io/ui/getting-started/browser-support/)).
|
|
|
|
## Code of conduct
|
|
|
|
By participating, you agree to follow our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|