0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
router/CONTRIBUTING.md
Leo Vigna 37256b22d1
docs: fix contributing guide to explicilty mention build:all command (#1244)
* fix contributing guide to explicilty mention build:all command

* add example usage link to README.md
2024-03-01 22:22:15 +01:00

1.1 KiB

Contributing

  • Clone the repo
    • gh repo clone TanStack/router
  • 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:all (build all packages) or
    • pnpm build (cached build with nx affected) or
    • pnpm dev
  • Navigate to an example
    • cd examples/react/basic
  • 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
  • Changes to the docs
    • Be sure that internal links are written always relative to docs folder. E.g. ./guide/data-loading