Skip to content

add chromium install for m1 notes to contributing.md #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 14, 2023
Merged

add chromium install for m1 notes to contributing.md #559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,42 @@

## Setup

First fork this project
First fork this project and install dependencies:

```bash
git clone <your-forked-repo>
yarn install
git checkout -b my-fix
```

Then fix some code and
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:

```bash
git commit -m "added this feature"
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
yarn install
unset PUPPETEER_SKIP_CHROMIUM_DOWNLOAD
node node_modules/puppeteer/install.js
```

Once you're up and running, fix some code and:

```bash
git commit -m "fix: fixed this bug"
git push origin my-fix
```

Lastly, open a pull request on Github.

## Releasing

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

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

Things to be aware of:

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