manrajgrover/algorithms-js

Fix JSDocs strings

Open

#22 opened on 2017年8月1日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)JavaScript (132 forks)github user discovery
documentationenhancementgood first issuehacktoberfest

Repository metrics

Stars
 (200 stars)
PR merge metrics
 (PR metrics pending)

説明

Since auto documentation generation depends on JS DocStrings, there is need to fix and provide as much information possible.

Reference: http://usejsdoc.org/index.html

コントリビューターガイド

調査方針
コードベース内の既存の JSDoc コメントを確認し、JSDoc 標準 (usejsdoc.org) に従って更新します。関数、パラメーター、戻り値の型が適切に文書化されていることを確認してください。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JavaScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90