Skip to content

Commit

Permalink
Update contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
petyosi committed Feb 8, 2025
1 parent 36e65b4 commit f362773
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# Contributing to React Virtuoso

Want to contribute to React Virtuoso? You will encounter a state management you are not familiar with - it's implemented using [URX](https://urx.virtuoso.dev).
Check the examples and the conceptual docs to get the gist of it.
## Run the project locally

### How to add fixes and new features
The repository uses NPM, [turborepo](https://turbo.build/), and [changesets](https://github.com/changesets/changesets) for its infrastructure. The `react-virtuoso` package has a [ladle](https://ladle.dev/) setup for examples, test cases, and bug reproductions. Run `npm run dev` inside `packages/react-virtuoso`.

Virtuoso has an extensive unit/e2e test suite. To run the unit tests, use `pnpm run test`. An end-to-end browser-based test suite is runnable with `pnpm run e2e`.
## Add fixes and new features

A convenient way to debug something is to preview the test cases in the browser.
To do that, run `pnpm run dev` - it will open a simple UI that lets you browse the components in the `examples` folder.

### How to add to the docs

The documentation site is built with docusaurus and the content is available in the `site/docs` directory.
The API reference is generated from the doc comments in `src/components.tsx`.
Virtuoso has an extensive unit/E2E test suite. To run the unit tests, use `npm run test`. You can run the end-to-end browser-based test suite with `npm run e2e`, which executes a Playwright test suite against the ladle examples.

0 comments on commit f362773

Please sign in to comment.