libgit2 / libgit2/pygit2

`peel` arguments inconsistent.

Open
#680 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
408
Avg merge
2d 57m
Merged PRs (30d)
7

Description

peel is implemented twice, once in object.c and once in reference.c. In the first it requires an argument and in the second it provides a default argument of None. This is confusing when branches can be 'default' peeled but tags cannot.

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

Compare the two peel implementations in object.c and reference.c, focusing on their argument handling for branches and tags. Establish one consistent behavior for the optional argument, then verify that both implementations expose the same interface and that default peeling remains correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
devtools
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.