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: update contributing.md (#7443)

Browse Source
This commit is contained in:
TASNEEM KOUSHAR 2021-07-30 17:15:55 +05:30 committed by GitHub
parent 18ed92bd08
commit 5b095f7183
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -13,6 +13,7 @@
* [API guidelines](#api-guidelines) * [API guidelines](#api-guidelines)
* [Commit Messages](#commit-messages) * [Commit Messages](#commit-messages)
* [Writing Documentation](#writing-documentation) * [Writing Documentation](#writing-documentation)
* [Writing TSDoc Comments](#writing-tsdoc-comments)
* [Adding New Dependencies](#adding-new-dependencies) * [Adding New Dependencies](#adding-new-dependencies)
* [Running & Writing Tests](#running--writing-tests) * [Running & Writing Tests](#running--writing-tests)
* [Public API Coverage](#public-api-coverage) * [Public API Coverage](#public-api-coverage)
@ -171,6 +172,17 @@ To format the documentation markdown and its code snippets, use:
npm run markdownlint-fix 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.
## Adding New Dependencies ## Adding New Dependencies
For all dependencies (both installation and development): For all dependencies (both installation and development):