github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: contributing.md tidy-up (#7449)

Browse Source
This commit is contained in:
Jack Franklin 2021-07-30 13:07:05 +01:00 committed by GitHub
parent 5b095f7183
commit 8781cfb30d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -174,14 +174,10 @@ npm run markdownlint-fix
## Writing TSDoc Comments
When commenting, consider the following:
- Every new method needs to have either `@public` or `@internal` added depending on if it is part of the public API
- Use Markdown syntax when writing documentation.
- If column size comment is exceeding 90 please split it over multiple lines instead of placing all in one line. One can use Rewrap plugin for comment formatting.
- Prefixing your comments with `FIXME` or `TODO` helps other developers quickly understand if you’re pointing out a problem that needs to be revisited, or if you’re suggesting a solution to the problem that needs to be implemented.
- please refer to the [API Extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) documentation.
Each change to Puppeteer should be thoroughly documented using TSDoc comments. Refer to the [API Extractor documentation](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) for information on the exact syntax.
- 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!
## Adding New Dependencies