You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-8Lines changed: 16 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -2,33 +2,42 @@
2
2
3
3
## Setup
4
4
5
-
First fork this project
5
+
First fork this project and install dependencies:
6
6
7
7
```bash
8
8
git clone <your-forked-repo>
9
9
yarn install
10
10
git checkout -b my-fix
11
11
```
12
12
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:
14
14
15
15
```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"
17
26
git push origin my-fix
18
27
```
19
28
20
29
Lastly, open a pull request on Github.
21
30
22
31
## Releasing
23
32
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).
25
34
We use [release-please](https://github.com/googleapis/release-please) workflow for releases. The [workflow](./.github/workflows/release-please.yml) is responsible for:
26
35
27
36
- Creating release PRs
28
37
- 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)
32
41
33
42
Things to be aware of:
34
43
@@ -43,4 +52,3 @@ Things to be aware of:
43
52
3. Merge the release PR
44
53
4. Verify that the new version is available in npm
0 commit comments