diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0da9c87d..b97246c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: @@ -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. \ No newline at end of file +> 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.