|
1 | 1 | # Contributing |
2 | | - |
3 | | -Thank you for considering contributing to Symfony UX! |
| 2 | + |
| 3 | +Thank you for considering contributing to Symfony UX! |
4 | 4 |
|
5 | 5 | Symfony UX is an open source, community-driven project, and we are happy to receive contributions from the community! |
6 | 6 |
|
@@ -39,15 +39,15 @@ To set up the development environment, you need the following tools: |
39 | 39 |
|
40 | 40 | - [PHP](https://www.php.net/downloads.php) 8.1 or higher |
41 | 41 | - [Composer](https://getcomposer.org/download/) |
42 | | -- [Node.js](https://nodejs.org/en/download/package-manager) 22 or higher |
| 42 | +- [Node.js](https://nodejs.org/en/download/package-manager) 22.11 or higher |
43 | 43 | - [Corepack](https://github.com/nodejs/corepack) |
44 | | -- [Yarn](https://yarnpkg.com/) 4 or higher |
| 44 | +- [PNPM](https://pnpm.io/) 10.13 or higher |
45 | 45 |
|
46 | 46 | With these tools installed, you can install the project dependencies: |
47 | 47 |
|
48 | 48 | ```shell |
49 | 49 | $ composer install |
50 | | -$ corepack enable && yarn install |
| 50 | +$ corepack enable && pnpm install |
51 | 51 | ``` |
52 | 52 |
|
53 | 53 | ### Linking Symfony UX packages to your project |
@@ -79,17 +79,17 @@ Assets are specific to each Symfony UX package: |
79 | 79 | - Assets **must be** compatible with the [Symfony AssetMapper](https://symfony.com/doc/current/frontend/asset_mapper.html) and [Symfony Webpack Encore](https://symfony.com/doc/current/frontend/encore/index.html). |
80 | 80 |
|
81 | 81 | To help you with assets, you can run the following commands in a specific package directory (e.g., `src/Map/assets/`): |
82 | | - - `yarn run build`: build (compile) assets from the package, |
83 | | - - `yarn run watch`: watch for modifications and rebuild assets from the package, |
84 | | - - `yarn run test`: run the tests from the package, |
85 | | - - `yarn run check`: run the formatter, linter, and sort imports, and fails if any modifications |
86 | | - - `yarn run check --write`: run the formatter, linter, imports sorting, and write modifications |
87 | | - |
88 | | -Thanks to [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you can also run these commands from the root directory of the project: |
89 | | - - `yarn run build`: build (compile) assets from **all** packages, |
90 | | - - `yarn run test`: run the tests from **all** packages, |
91 | | - - `yarn run check`: run the formatter, linter, and sort imports for **all** packages, and fails if any modifications |
92 | | - - `yarn run check --write`: run the formatter, linter, imports sorting for **all** packages, and write modifications |
| 82 | + - `pnpm run build`: build (compile) assets from the package, |
| 83 | + - `pnpm run watch`: watch for modifications and rebuild assets from the package, |
| 84 | + - `pnpm run test`: run the tests from the package, |
| 85 | + - `pnpm run check`: run the formatter, linter, and sort imports, and fails if any modifications |
| 86 | + - `pnpm run check --write`: run the formatter, linter, imports sorting, and write modifications |
| 87 | + |
| 88 | +Thanks to [PNPM Workspaces](https://pnpm.io/workspaces), you can also run these commands from the root directory of the project: |
| 89 | + - `pnpm run build`: build (compile) assets from **all** packages, |
| 90 | + - `pnpm run test`: run the tests from **all** packages, |
| 91 | + - `pnpm run check`: run the formatter, linter, and sort imports for **all** packages, and fails if any modifications |
| 92 | + - `pnpm run check --write`: run the formatter, linter, imports sorting for **all** packages, and write modifications |
93 | 93 |
|
94 | 94 | ### Working on documentation |
95 | 95 |
|
|
0 commit comments