How to Contribute
This guide explains how to contribute to Tabler, from setting up a development environment to making and testing changes. It covers essential steps like forking the repository, installing dependencies, and submitting a pull request to help improve Tabler's features and functionality.
Contributions are always welcome and highly encouraged! Whether you’re new to open source or a seasoned contributor, your input helps make Tabler better for everyone. If you’re new to open source, start here to learn more about contributing.
Contribution Requirements
When contributing to Tabler, please adhere to the following guidelines:
- By submitting a contribution, you grant a non-exclusive license to the Tabler project to use your contribution in any context deemed appropriate.
- If your contribution includes content from other sources, it must be appropriately licensed under an open source license.
- Contributions must be submitted via GitHub pull requests.
- Ensure your code works in all supported browsers (refer to our browser support documentation).
Installation
Follow these steps to set up Tabler for development:
-
Fork the repository: Guide to forking.
-
Clone the repository to your local machine:
git clone https://github.com/YOUR_USERNAME/tabler.git -
Create a new branch for your changes:
git checkout -b your-branch-name
Development
To set up Tabler for development, follow these steps:
Ensure Node.js and npm are installed
You’ll need Node.js (v20 or higher) and pnpm to compile Tabler’s files. If you don’t have them installed, download and install them from the official websites:
Install Ruby and Bundler
Tabler uses Ruby and Bundler to manage dependencies. Install Ruby and Bundler by following the instructions in the Ruby documentation and the Bundler website.
Install dependencies
Run the following command to install all required npm packages. We recommend using pnpm for faster installation:
pnpm install
Install Jekyll
Tabler uses Jekyll to build the documentation. Install Jekyll by running the following command:
bundle install
Start developer mode
Use the following command to enable autocompilation with live reload. This will start a local server at http://localhost:3000/:
pnpm run dev
Make changes
Make your changes in the appropriate folders, such as ./src/ or ./docs/. Avoid modifying files in ./dist/, as they are auto-generated during the build process and will be overwritten.
Compiling for Production
Before submitting a pull request, ensure your changes are properly compiled and tested:
-
Compile the production files
pnpm run build -
Test all pages to confirm everything works as expected.
Submitting Your Contribution
Once your changes are ready, create a pull request (PR) on GitHub. Make sure to include a clear and concise description of the changes and their purpose. Thank you for contributing to Tabler!
