Add & Improve JSDocs
@erisu がすでに取り組んでいます。
2026年6月23日 から。
評価
この issue はまだ評価されていません。
説明
Goal
The goal of this ticket is to investigate and expand the project's JSDoc coverage to improve in-code documentation and make the codebase easier to understand and maintain.
Bonus
Explore options for extracting and rendering the JSDocs as a static documentation site.
There are tools available that can generate Markdown from JSDoc comments, making it possible to use a GitHub Action to build and deploy the documentation automatically.
List of APIs
TODO: Create a checkbox list of all APIs and check them when JSDocs are added or improved.
- 主要言語
- JavaScript
- スター
- 217
- フォーク
- 102
- 平均マージ
- 2日 9時間
- マージ済み PR(30日)
- 8
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/cordova-node-xcode のほかの issue
-
🔖 New release オープン
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
apache/cordova-node-xcode#162 · コメント 4 件 · リアクション 2 件 ·
-
Install .xcframework オープン
難易度 3/5 1〜2日 初心者へのやさしさ 28/100
apache/cordova-node-xcode#139 · コメント 2 件 ·
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
apache/cordova-node-xcode#138 · コメント 2 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
apache/cordova-node-xcode#137 · リアクション 2 件 ·
-
BUG - addTargetDependency - If project doesn't contain PBXTargetDependency or PBXContainerItemProxy オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 52/100
apache/cordova-node-xcode#121 · リアクション 2 件 ·
apache/cordova-node-xcode の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
antfu-collective/icones#398 ·
-
ECmail.com オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
wesbos/burner-email-providers#554 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
components-web-app/docs#92 ·