libgit2 / libgit2/libgit2sharp

Documentation refers to non-existant APIs due to refactorings

Open
#1,478 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
3.5k
Forks
925
PR merge metrics
No merged PRs in 30d

Description

This documentation:

https://github.com/libgit2/libgit2sharp/wiki/Git-merge-base

refers to:

var baseCommit = repo.Commits.FindMergeBase(aCommit, bCommit);

while it appears to have been moved here:

https://github.com/libgit2/libgit2sharp/pull/957/files

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Git-merge-base wiki page and compare its example with the API location shown in pull request #957. Confirm the current merge-base method name and update the documentation example so it no longer refers to the moved API; verify the page contains a working reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.