Contribution Guide

Monorepository that holds the package consists of package itself and docs that you're reading. Here's described how you can deploy everything locally and start development.

Both package and docs managed with pnpm (opens in a new tab) and it's workspaces (opens in a new tab) feature. So first of all you should install it.

Package

Bottom Sheet is built with Vite (opens in a new tab) so you can instantly preview results of your work in playground. To get started, go to package folder, install deps and run dev server:

cd ./packages/react-bottom-sheet
pnpm install
pnpm dev # Congrats! You can now visit playground, usually http://localhost:5173

Finally, you can build component for production:

pnpm build

Build results located in ./package/react-bottom-sheet/lib.

⚠️

Don't forget to check the build, and preview component in the docs! (described below)

Docs

Docs are created with Nextra (opens in a new tab), framework built on Next.js (opens in a new tab). You can read Nextra's docs in order to catch up advanced topics, but if you want to introduce minon changes you can keep reading.

As with core package, getting started is pretty trivial:

cd ./packages/docs
pnpm install
pnpm dev # http://localhost:3000 or similar should be avaliable for preview

Again, you can prerender docs and be sure that everything is fine:

pnpm build

Pull Request Policy

TBD, so feel free to do them freeform!

General Credits