You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Thank you for considering contributing to Symfony UX!
5
5
Symfony UX is an open source, community-driven project, and we are happy to receive contributions from the community!
6
6
7
7
> [!TIP]
8
-
> It's a good idea to read the [Symfony's Contribution Guide](https://symfony.com/doc/current/contributing/index.html) first, even if not all of it applies to Symfony UX and should be adapted to this project (e.g.: Symfony UX has only one base branch, `2.x`).
8
+
> It's a good idea to read the [Symfony's Contribution Guide](https://symfony.com/doc/current/contributing/index.html) first
9
9
10
10
## Reporting an issue
11
11
@@ -27,6 +27,10 @@ This will give you a copy of the code under your GitHub user account, read [the
27
27
After forking the repository, you can clone it to your local machine:
# Add the upstream repository, to keep your fork up-to-date
@@ -41,12 +45,15 @@ To set up the development environment, you need the following tools:
41
45
-[Composer](https://getcomposer.org/download/)
42
46
-[Node.js](https://nodejs.org/en/download/package-manager) 22.18 or higher
43
47
-[Corepack](https://github.com/nodejs/corepack)
44
-
-[PNPM](https://pnpm.io/) 10.13 or higher
48
+
-[PNPM](https://pnpm.io/) 10.16.1 or higher
45
49
46
50
With these tools installed, you can install the project dependencies:
47
51
48
52
```shell
53
+
# Install root PHP dependencies
49
54
$ composer install
55
+
56
+
# Enable PNPM through Corepack, and install JavaScript dependencies
50
57
$ corepack enable&& pnpm install
51
58
```
52
59
@@ -73,7 +80,7 @@ runnable with `php vendor/bin/simple-phpunit`.
73
80
### Working with assets
74
81
75
82
Assets are specific to each Symfony UX package:
76
-
- They are located in the `assets/` directory of each package, and can be either TypeScript or CSS files, respectively compiled through Rollup and PostCSS,
83
+
- They are located in the `assets/` directory of each package, and can be either TypeScript or CSS files, all compiled through [tsup](https://github.com/egoist/tsup),
77
84
- Assets are mentioned in the `package.json` file of each package,
78
85
- Assets **must be** compiled before committing changes,
79
86
- 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).
@@ -111,7 +118,7 @@ for example: `src/Vue/assets/test/unit/render_controller.test.ts`.
111
118
> [!IMPORTANT]
112
119
> The command `pnpm run test:unit` ensure that each possible combination of dependencies is tested
113
120
> (e.g., `"chart.js": "^3.4.1 || ^4.0"` for UX Chartjs).
114
-
> Thus it may take some time to run, and it may be not recommended to use watch mode.
121
+
> Thus it may take some time to run, and **we don't recommend to use watch mode**.
115
122
116
123
#### Working with End-to-End (E2E) tests
117
124
@@ -156,17 +163,17 @@ command from the root directory of the project:
156
163
docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}:/docs oskarstark/doctor-rst -vvv
157
164
```
158
165
159
-
## Useful Git commands
166
+
## Useful commands
160
167
161
-
1.To keep your fork up-to-date with the upstream repository and `2.x` branch, you can run the following commands:
168
+
To keep your fork up-to-date with the upstream repository and `2.x` branch:
162
169
```shell
163
170
$ git checkout 2.x && \
164
171
git fetch upstream && \
165
172
git reset --hard upstream/2.x && \
166
173
git push origin 2.x
167
174
```
168
175
169
-
2.To rebase your branch on top of the `2.x` branch, you can run the following commands:
0 commit comments