Skip to content

Commit

Permalink
feat(lhci,lighhouse-cil): Huge update needed to add custom gatherer
Browse files Browse the repository at this point in the history
This huge and needed update add a custom gatherer (a lighthouse tool who make mesuress) who count the DOM of the pages deferently. This impact how to use the plugin with `lighthouse-cli` and `lighthouse ci`aka `lhci`.
Consult the documentation to update your configuration file.

BREAKING CHANGE:
  • Loading branch information
hrenaud committed Apr 29, 2024
1 parent cb3debd commit 7777517
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ We'd love to accept your patches and contributions to this project. There are ju

# Development environment setup

Use VSCODE as your IDE with Docker and devcontainer extension installed.
Use Docker, VSCODE as your IDE with and devcontainer extension installed.

The decontainer will setup the development environment for you. It will install all the necessary tools and dependencies (recommanded plugins, lighthouse server aka lhci preconfigured w/ bdd embed, etc).

Two versions of the devcontainer are available:
- `silicon/devcontainer.json` for Apple silicon M* processors — linux/amd64

- `silicon/devcontainer.json` for Apple silicon M\* processors — linux/amd64
- `intel/devcontainer.json` for Intel processors (NOT TESTED)

After you launched the devcontainer, you **NEED** to run the following commands to finish the setup of the development server:
Expand All @@ -19,9 +20,10 @@ sh /workspace/.devcontainer/commons/updateContentCommand/updateContentCommand.sh
```

# Elements

- `lighthouse-plugin-ecoindex/` folder contains the plugin code
- `examples-developpement-test/` folder contains the developpements to test the plugin for `lhci`, `lighthouse` and `npx lighthouse-plugin-ecoindex` commands
- `examples/` folder contains the examples of the plugin for `lhci`, `lighthouse` and `npx lighthouse-plugin-ecoindex` commands, for the documentation
- `docs` folder contains the documentation of the plugin

> Don't forget to sync the `examples-developpement-test/` folder with the `examples/` folder before pushing your changes and to update the documentation in the `docs` folder. If you change the devcontainer, don't forget to sync your updates to the `silicon` and `intel` folders.
> Don't forget to sync the `examples-developpement-test/` folder with the `examples/` folder before pushing your changes and to update the documentation in the `docs` folder. If you change the devcontainer, don't forget to sync your updates to the `silicon` and `intel` folders.

0 comments on commit 7777517

Please sign in to comment.