libgit2 / libgit2/libgit2sharp

Improve GlobalSettings documentation with regards to shared state "dragons"

未關閉
#1,148 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

找出 GlobalSettings 文件以及相關的 Repository 生命週期文件。閱讀 GlobalSettings 註冊如何存續超過一個 Repository,然後更新文件,說明共用狀態的風險,以及為什麼解除註冊時必須考慮其他仍在執行的 repository;當行為和注意事項都獲得清楚記錄時,即視為完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp
領域
documentation
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
需要釐清
新手友好度
30/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。