libgit2 / libgit2/libgit2sharp
Improve GlobalSettings documentation with regards to shared state "dragons"
オープン
まだ誰も着手していません。
Stabilization
- 主要言語
- C#
- スター
- 3.5k
- フォーク
- 925
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
From #1119
maybe should we also improve the documentation of this type. Indeed, this type holds registrations that exceeds the lifespan of a
Repository.I feel that pretty strange side-effects may happen would we blindly deregister while some repos are still alive and leveraging those.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
GlobalSettings のドキュメントと、関連する Repository のライフサイクルに関するドキュメントを見つけます。GlobalSettings の登録が Repository より長く存続する仕組みを読み、共有状態のリスクと、登録解除で他の存続中の Repository を考慮する必要がある理由を説明するようドキュメントを更新します。動作と注意点が明確に文書化されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100