benthayer / benthayer/git-gud

"pre-commit" hook to make sure users are committing all of their changes

Open
#254 4 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
558
Forks
53
PR merge metrics
No merged PRs in 30d

Description

People can get confused about the staging area:
- They create a file and think "git commit" will already know about it and will commit it
- They create a file, then add it, then go on to make further modifications, thinking that git now knows about it

We can solve this by telling them "Git Gud has blocked your commit because your staging area is not the same as your working directory."

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Start by locating the commit command and any existing pre-commit hook handling, then reproduce both staging-area examples; done means a commit is blocked when the staging area differs from the working directory and the stated explanation is shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
cli, developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.