Skip to content

Latest commit

 

History

History
20 lines (19 loc) · 795 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (19 loc) · 795 Bytes

Contributing

  • Clone the repo
    • gh repo clone ChezPaul
  • Ensure node is installed
  • Ensure pnpm is installed
    • https://pnpm.io/installation
    • Why? We use pnpm to manage workspace dependencies. It's easily the best monorepo/workspace experience available as of when this was written.
  • Install dependencies
    • pnpm install
    • This installs dependencies for all of the packages in the monorepo, even examples!
    • Dependencies inside of the packages and examples are automatically linked together as local/dynamic dependencies.
  • Run the build or dev watcher
    • pnpm build or
    • pnpm dev
  • Run the example
    • pnpm dev
  • Make changes to the code
    • If you ran pnpm dev the dev watcher will automatically rebuild the code that has changed