diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a18fff9..52e3b35 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,13 +6,24 @@ If you plan to contribute to flatpak-github-actions, here's a couple of things t - NodeJS 16.x or newer - Yarn -- `@vercel/ncc` you can install it with `yarn global add @vercel/ncc` For more details, we recommend looking the extensive guide at [Creating a JavaScript action](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#prerequisites) +```shell +yarn global add @vercel/ncc +yarn --cwd flatpak-builder --frozen-lockfile && yarn --cwd flat-manager --frozen-lockfile +``` + Once you have modified the `index.js` of either `flatpak-builder` or `flat-manager` action. Make sure to compile the file to the `dist` directory. You can do so with ```shell ncc build ./flatpak-builder/index.js -o ./flatpak-builder/dist/ ncc build ./flat-manager/index.js -o ./flat-manager/dist/ ``` + +## Linting + +```shell +yarn --cwd flatpak-builder install --also=dev && yarn --cwd flat-manager install --also=dev +yarn --cwd flatpak-builder run eslint . --fix && yarn --cwd flat-manager run eslint . --fix +```