libgit2 / libgit2/libgit2sharp
A better SubmoduleStatus?
Open
Nobody has claimed this yet.
Stabilization
- Dominant language
- C#
- Stars
- 3.5k
- Forks
- 925
- PR merge metrics
- No merged PRs in 30d
Description
As discussed in https://github.com/libgit2/libgit2sharp/issues/1103#issuecomment-113903882
Maybe should we
- Move
Submodule.RetrieveStatus()intoSubmoduleCollection.RetrieveSubmoduleStatus() - Turn
SubmoduleStatusinto a concrete type, which would exposeIsUnmodifiedandIsWorkingDirectoryDirtyshortcut properties along with another one which would maybe expose the flags? This may leave us some room for future improvement (conflicts, ...)
Quote from @dahlbyk
"Now that you mention it, I agree that the SubmoduleStatus API has some room for improvement (SRP violation, communicating both superproject and submodule status)."
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
Start with the linked discussion in issue 1103 and inspect the existing Submodule.RetrieveStatus(), SubmoduleCollection, and SubmoduleStatus APIs. The issue does not name files or tests. Done would require an agreed API redesign covering status ownership, shortcut properties, and future status flags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, git
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100