Skip to content

Commit 0c82a11

Browse files
committed
Minor improvements on CONTRIBUTING.md
1 parent 7c4f5e6 commit 0c82a11

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Thank you for considering contributing to Symfony UX!
55
Symfony UX is an open source, community-driven project, and we are happy to receive contributions from the community!
66

77
> [!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
99
1010
## Reporting an issue
1111

@@ -27,6 +27,10 @@ This will give you a copy of the code under your GitHub user account, read [the
2727
After forking the repository, you can clone it to your local machine:
2828

2929
```shell
30+
# With GitHub CLI https://cli.github.com/
31+
$ gh repo clone <USERNAME>/symfony-ux symfony-ux
32+
33+
# Using SSH
3034
$ git clone [email protected]:<USERNAME>/symfony-ux.git symfony-ux
3135
$ cd symfony-ux
3236
# 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:
4145
- [Composer](https://getcomposer.org/download/)
4246
- [Node.js](https://nodejs.org/en/download/package-manager) 22.18 or higher
4347
- [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
4549

4650
With these tools installed, you can install the project dependencies:
4751

4852
```shell
53+
# Install root PHP dependencies
4954
$ composer install
55+
56+
# Enable PNPM through Corepack, and install JavaScript dependencies
5057
$ corepack enable && pnpm install
5158
```
5259

@@ -73,7 +80,7 @@ runnable with `php vendor/bin/simple-phpunit`.
7380
### Working with assets
7481

7582
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),
7784
- Assets are mentioned in the `package.json` file of each package,
7885
- Assets **must be** compiled before committing changes,
7986
- 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`.
111118
> [!IMPORTANT]
112119
> The command `pnpm run test:unit` ensure that each possible combination of dependencies is tested
113120
> (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**.
115122
116123
#### Working with End-to-End (E2E) tests
117124

@@ -156,17 +163,17 @@ command from the root directory of the project:
156163
docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}:/docs oskarstark/doctor-rst -vvv
157164
```
158165

159-
## Useful Git commands
166+
## Useful commands
160167

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:
162169
```shell
163170
$ git checkout 2.x && \
164171
git fetch upstream && \
165172
git reset --hard upstream/2.x && \
166173
git push origin 2.x
167174
```
168175

169-
2. To rebase your branch on top of the `2.x` branch, you can run the following commands:
176+
To rebase your branch on top of the `2.x` branch:
170177
```shell
171178
$ git checkout my-feature-branch && \
172179
git rebase upstream/2.x && \

0 commit comments

Comments
 (0)