thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add website details to contributing.md

Browse Source
This commit is contained in:
TASNEEM KOUSHAR 2021-09-01 14:00:37 +05:30 committed by GitHub
parent 930bff5e52
commit 301f523956
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -14,6 +14,7 @@
* [Commit Messages](#commit-messages)
* [Writing Documentation](#writing-documentation)
* [Writing TSDoc Comments](#writing-tsdoc-comments)
* [Running New Documentation website locally](#running-new-documentation-website-locally)
* [Adding New Dependencies](#adding-new-dependencies)
* [Running & Writing Tests](#running--writing-tests)
* [Public API Coverage](#public-api-coverage)
@ -179,6 +180,15 @@ Each change to Puppeteer should be thoroughly documented using TSDoc comments. R
- Every new method needs to have either `@public` or `@internal` added as a tag depending on if it is part of the public API.
- Keep each line in a comment to no more than 90 characters (ESLint will warn you if you go over this). If you're a VSCode user the [Rewrap plugin](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap) is highly recommended!
## Running New Documentation website locally
- In the Puppeteer's folder, install all dependencies with `npm i`.
- run `npm run generate-docs` which will generate all the `.md` files on `puppeteer/website/docs`.
- run `npm i` on `puppeteer/website`.
- run `npm start` on `puppeteer/website`.
## Adding New Dependencies
For all dependencies (both installation and development):