Skip to content

Commit fca9d45

Browse files
mathiasbynensaslushnikov
authored andcommitted
docs(CONTRIBUTING.md): clarify release process (#4923)
After bumping the package.json version number, maintainers should run `npm run doc` to automatically update README.md and docs/api.md accordingly.
1 parent 97ff359 commit fca9d45

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ See [Debugging Tips](README.md#debugging-tips) in the readme.
238238
Releasing to npm consists of the following phases:
239239

240240
1. Source Code: mark a release.
241-
1. Bump `package.json` version following the SEMVER rules and send a PR titled `'chore: mark version vXXX.YYY.ZZZ'` ([example](https://github.com/GoogleChrome/puppeteer/commit/808bf8e5582482a1d849ff22a51e52024810905c)).
241+
1. Bump `package.json` version following the SEMVER rules, run `npm run doc` to update the docs accordingly, and send a PR titled `'chore: mark version vXXX.YYY.ZZZ'` ([example](https://github.com/GoogleChrome/puppeteer/commit/808bf8e5582482a1d849ff22a51e52024810905c)).
242242
2. Make sure the PR passes **all checks**.
243243
- **WHY**: there are linters in place that help to avoid unnecessary errors, e.g. [like this](https://github.com/GoogleChrome/puppeteer/pull/2446)
244244
3. Merge the PR.

0 commit comments

Comments
 (0)