libgit2 / libgit2/libgit2sharp
Improve GlobalSettings documentation with regards to shared state "dragons"
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 925
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the GlobalSettings documentation and the related Repository lifecycle documentation. Read how GlobalSettings registrations outlive a Repository, then update the documentation to explain the shared-state risks and why deregistration must account for other live repositories; done means the behavior and caution are clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100