Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 1.82 KB
Raw

Contributing to Material React Table

Suggesting New Features or Bug Fixes

Before making large PRs, you may want to discuss your proposals in either the Discord Contributing Channel, the GitHub Discussions page, or the GitHub Issues page.

Running the project locally

This project uses PNPM and a TurboRepo with 2 projects.

  • The library itself in /packages/material-react-table which also contains a storybook site for local development
  • The docs site in /apps/material-react-table-docs

1. Fork and Clone the project

Create your own fork, clone, and then make a feature/bugfix branch off of v2. Branch name does not really matter.

2. Install Dependencies

pnpm i

3. Run the project(s)

Run the Storybook for Local Development

pnpm storybook

The Storybook site will open on port 6006 by default.

Run the Docs for Local Development

pnpm docs:dev

The Docs site will open on port 3000 by default.

Note: If you are contributing a new locale and are trying to test it in the docs site, you will need to run pnpm lib:build-locales and then pnpm docs:dev before it can be imported.

Fully Build the Library

pnpm lib:build

Note: After building the library, if you are running the docs site locally, it will use the compiled output of the dist folder. This can be annoying if you are trying to test changes to the library in the docs site itself. Just delete the /dist folder and restart the docs app to test lib changes in the docs site.