Skip to content

Commit ce5753f

Browse files
authored
Some doc improvements (#245)
* docs: Add prerequisites for regenerating dist with ncc * docs: Add linting information
1 parent fef33cb commit ce5753f

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,24 @@ If you plan to contribute to flatpak-github-actions, here's a couple of things t
66

77
- NodeJS 16.x or newer
88
- Yarn
9-
- `@vercel/ncc` you can install it with `yarn global add @vercel/ncc`
109

1110
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)
1211

12+
```shell
13+
yarn global add @vercel/ncc
14+
yarn --cwd flatpak-builder --frozen-lockfile && yarn --cwd flat-manager --frozen-lockfile
15+
```
16+
1317
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
1418

1519
```shell
1620
ncc build ./flatpak-builder/index.js -o ./flatpak-builder/dist/
1721
ncc build ./flat-manager/index.js -o ./flat-manager/dist/
1822
```
23+
24+
## Linting
25+
26+
```shell
27+
yarn --cwd flatpak-builder install --also=dev && yarn --cwd flat-manager install --also=dev
28+
yarn --cwd flatpak-builder run eslint . --fix && yarn --cwd flat-manager run eslint . --fix
29+
```

0 commit comments

Comments
 (0)