rust-lang / rust-lang/git2-rs

Shouldn't the index.remove method take an enum?

Open
#870 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Rust
Stars
2.1k
Forks
450
Avg merge
11m
Merged PRs (30d)
1

Description

This method (index.remove) takes an i32 as a stage param, but it is unclear what it does. There are some possible values on the libgit2 documentation, shouldn't be added as an enum?

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

Start with the Index::remove method and the linked libgit2 git_index_stage_t documentation. Determine the intended stage values and how this Rust binding exposes related parameters; done means the stage argument has a clear enum-based API with the existing behavior preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.