PortToDocs adding inheritdoc for types which aren't publicly documented
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- csharp
- 領域
- documentation, tooling
調査の方向性
まず PortToDocs の実装と、inheritdoc または公開ドキュメントを対象とする既存のテストを見つけます。inheritdoc の対象がどのように選択されるかを追跡します。ドキュメントを移植する際に、公開ドキュメントの一部ではない対象が除外されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The tool should make sure that the target of inheritdoc is part of the public docs. If not, it should exclude that when porting the docs over.
- 主要言語
- C#
- スター
- 14
- フォーク
- 22
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
dotnet/api-docs-sync のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
dotnet/api-docs-sync#182 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
dotnet/api-docs-sync#181 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
dotnet/api-docs-sync#180 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
dotnet/api-docs-sync#179 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
dotnet/api-docs-sync#177 ·
dotnet/api-docs-sync の issue をすべて見る
似ている issue
-
NEW ISSUE Requestor-TML Maintainers Type: Change/Feature Request
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
tModLoader/tModLoader#5476 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
521xueweihan/HelloGitHub#3845 · コメント 1 件 ·
-
possible bug
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
documentation task
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
lay295/TwitchDownloader#1675 ·