From 5b095f71832ab8e717f4f6612612c48a49c77c94 Mon Sep 17 00:00:00 2001 From: TASNEEM KOUSHAR Date: Fri, 30 Jul 2021 17:15:55 +0530 Subject: [PATCH] chore: update contributing.md (#7443) --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8eb6e872..7a1ba913 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ * [API guidelines](#api-guidelines) * [Commit Messages](#commit-messages) * [Writing Documentation](#writing-documentation) + * [Writing TSDoc Comments](#writing-tsdoc-comments) * [Adding New Dependencies](#adding-new-dependencies) * [Running & Writing Tests](#running--writing-tests) * [Public API Coverage](#public-api-coverage) @@ -171,6 +172,17 @@ To format the documentation markdown and its code snippets, use: 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 For all dependencies (both installation and development):