|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -## Setup |
4 | | - |
5 | | -First fork this project and install dependencies: |
6 | | - |
7 | | -```bash |
8 | | -git clone <your-forked-repo> |
9 | | -yarn install |
10 | | -git checkout -b my-fix |
11 | | -``` |
12 | | - |
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 | | - |
15 | | -```bash |
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" |
26 | | -git push origin my-fix |
27 | | -``` |
28 | | - |
29 | | -Lastly, open a pull request on Github. |
30 | | - |
31 | | -## Releasing |
32 | | - |
33 | | -This repo uses [semantic versioning](https://semver.org/) with the help of [release-please](https://github.com/googleapis/release-please). |
34 | | -We use [release-please](https://github.com/googleapis/release-please) workflow for releases. The [workflow](./.github/workflows/release-please.yml) is responsible for: |
35 | | - |
36 | | -- Creating release PRs |
37 | | -- Once release PRs are merged it: |
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) |
41 | | - |
42 | | -Things to be aware of: |
43 | | - |
44 | | -- use [conventional commits](https://www.conventionalcommits.org/) |
45 | | -- Only `feat` and `fix` commits will be released. `chore` commits will not create a release PR |
46 | | -- To jump versions e.g `v2.0` to `v3.0` make sure to indicate that in your PR by having a `Release-As` in the commit message e.g `Release-As: 3.0.0`. See ["How do I change the version number?"](https://github.com/googleapis/release-please#how-do-i-change-the-version-number) docs in release-please. |
47 | | - |
48 | | -#### Steps |
49 | | - |
50 | | -1. Merge your feature or bug fix PR |
51 | | -2. Release please creates a release PR |
52 | | -3. Merge the release PR |
53 | | -4. Verify that the new version is available in npm |
54 | | -5. Go to plugins and merge the version update PR |
| 3 | +Contributions and bug reports to the project are not being accepted at this time. |
0 commit comments