http-party/node-portfinder

Update documentation for `getPort`, `getPorts`, `getSocket`

Open

#170 opened on 2025年3月12日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)JavaScript (101 forks)github user discovery
good first issue

Repository metrics

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

説明

Update documentation for getPort, getPorts, getSocket

Follow the idea for docs from https://caolan.github.io/async/v3/docs.html#concat

see #168 and #169 for context.

Remove the *Promise based docs and only document getPort, getPorts, getSocket

Great issue for new contributors. Feel free to make a pull request! Don't hesitate to ask if you need help or are confused.

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

調査方針
言及されている関数の既存のドキュメントを確認し、asyncライブラリのconcatドキュメントで使用されているパターンに従って更新してください。Promiseベースのドキュメントはすべて削除してください。
技術スタック
javascript
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85