Convert code samples to executable code
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- csharp
- 領域
- documentation, testing
調査の方向性
まず #702 で完了した作業と既存の Docfx スニペットを確認し、その後、作業分解で要求されているとおり、プロジェクト内を調べて追加のスニペットを探します。優先順位付けされたサンプルが実際の C# ソリューションまたはプロジェクトでホストされ、ドキュメントに取り込まれ、該当する場合は CI によって検証されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Docfx has the ability to pull snippets from other files, including directly from C# code.
This means we can create a real solution/project, host code samples there and iterate on them, and pull the relevant sections into the docs.
Doing this will allow for:
- Verification of sample code
- Easier refactoring of samples to use good practices
- CI checking to ensure samples work and all tests pass
- Ability to show tests that fail too (and to ignore them in CI)
- Easier creation of more complex samples
- Sample code re-use eventually
Work Breakdown
- #702
- Comb the project for other possible snippets and add them to the list here
- Enlist others in populating these snippets in the real project
Snippets, in suggested order of priority:
TBD
- 主要言語
- Dockerfile
- スター
- 601
- フォーク
- 158
- 平均マージ
- 1日 3時間
- マージ済み PR（30日）
- 18
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
nunit/docs のほかの issue
-
type:newpage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
area:adapter area:framework
難易度 4/5 3〜5日 初心者へのやさしさ 40/100
nunit/docs#1258 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
area:framework
難易度 4/5 3〜5日 初心者へのやさしさ 40/100
メンテナーはふだん 1 日以内に返信
-
Document F# EqualToオープンarea:framework
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
area:framework
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stellar/stellar-dev-skill#151 ·
メンテナーはふだん 1 日以内に返信
-
fix formatting of the sample database page of the docs対応中かも @Aaqibhafeezkhan が今日担当しました。 オープンdocumentation good first issue help wanted
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
chaoss/CollectOSS#544 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
docs: clarify gh api -f vs -F and @-file expansion in the gh skill対応中かも @MatiasOlivera が今日担当しました。 オープンenhancement
難易度 2/5 半日 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 半日 初心者へのやさしさ 62/100
ibm-granite/granite.build#504 ·
メンテナーはふだん 2 日以内に返信
-
Say in the changelog that the text-index update cannot be rolled back対応中かも @praetorianer777 が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
praetorianer777/GoTome#275 ·
メンテナーはふだん 1 日以内に返信