libgit2 / libgit2/libgit2sharp

Style consistency

Open
#536 1 comment 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

Should we make a style consistency pass at some point? I notice, for example, that some things are named funny! What things should we be paying attention to?

  • Change names of ...Modifiers classes to ...Options
    • StashOptions
  • Change instances of Workdir or WorkingDirectory to WorkDir
    • Diff
    • DiffTargets

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

Review the proposed naming changes for ...Modifiers, StashOptions, Workdir, WorkingDirectory, Diff, and DiffTargets. First establish the complete naming scope and project conventions; done requires an agreed consistency plan and coordinated updates, but the issue does not mention files or tests to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.