Skip to content

Commit

Permalink
UPDATE: CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
neo-garaix committed Jan 31, 2025
1 parent 00a307d commit 2e0435b
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,22 +121,27 @@ You need some developer tools in order to build and install dependencies.
#### Requirements

* Install dependencies :
* `cd assets/`
* `npm install`
* `npm install` in root directory of the repository.

It creates a `assets/node_modules/` directory. Don't commit it into the git repository!
It creates a `node_modules/` directory. Don't commit it into the git repository!


#### Installation

* Build for production (minified JS files) :
* From `assets/` :
`npm run build`
* From root directory :
`npm run build --workspace=assets`

Don't commit minified JS files into the git repository. They will be built by our
continuous integration and added into zip packages that are available on github.

* Build for development (source mapping, build is executed at every change on a JS file) :
* From `assets/` :
`npm run watch`
* From root directory :
`npm run watch --workspace=assets`

Look at [webpack documentation](https://webpack.js.org/guides/development/) for other development options (e.g. live reloading)

Expand All @@ -162,7 +167,7 @@ Configuration of php-cs-fixer has been setup into .php-cs.dist.

### JavaScript

Please run `npm run pretest` in `assets/` directory and fix errors before any commit.
Please run `npm run pretest` in the root directory and fix errors before any commit.

## Issues

Expand Down

0 comments on commit 2e0435b

Please sign in to comment.