Skip to content

Commit d9be6a8

Browse files
authored
chore(docs): add chromium install for m1 notes to contributing.md (#559)
1 parent 2a8bdd2 commit d9be6a8

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,42 @@
22

33
## Setup
44

5-
First fork this project
5+
First fork this project and install dependencies:
66

77
```bash
88
git clone <your-forked-repo>
99
yarn install
1010
git checkout -b my-fix
1111
```
1212

13-
Then fix some code and
13+
If you are using an M1 Macbook, you might encounter an error while the `puppeteer` dependency installs the chromium browser. If this happens, try removing your `node_modules` folder and running:
1414

1515
```bash
16-
git commit -m "added this feature"
16+
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
17+
yarn install
18+
unset PUPPETEER_SKIP_CHROMIUM_DOWNLOAD
19+
node node_modules/puppeteer/install.js
20+
```
21+
22+
Once you're up and running, fix some code and:
23+
24+
```bash
25+
git commit -m "fix: fixed this bug"
1726
git push origin my-fix
1827
```
1928

2029
Lastly, open a pull request on Github.
2130

2231
## Releasing
2332

24-
This repo uses [semantic versioning](https://semver.org/) with the help of [release-please](https://github.com/googleapis/release-please).
33+
This repo uses [semantic versioning](https://semver.org/) with the help of [release-please](https://github.com/googleapis/release-please).
2534
We use [release-please](https://github.com/googleapis/release-please) workflow for releases. The [workflow](./.github/workflows/release-please.yml) is responsible for:
2635

2736
- Creating release PRs
2837
- Once release PRs are merged it:
29-
- creates a release [tag](https://github.com/netlify/netlify-plugin-lighthouse/releases)
30-
- publishes the new version to [npm](https://www.npmjs.com/package/@netlify/plugin-lighthouse)
31-
- creates an update PR in [plugins](https://github.com/netlify/plugins)
38+
- creates a release [tag](https://github.com/netlify/netlify-plugin-lighthouse/releases)
39+
- publishes the new version to [npm](https://www.npmjs.com/package/@netlify/plugin-lighthouse)
40+
- creates an update PR in [plugins](https://github.com/netlify/plugins)
3241

3342
Things to be aware of:
3443

@@ -43,4 +52,3 @@ Things to be aware of:
4352
3. Merge the release PR
4453
4. Verify that the new version is available in npm
4554
5. Go to plugins and merge the version update PR
46-

0 commit comments

Comments
 (0)