martient / martient/committy

Add WIP type and error system

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Rust
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

When working on a feature or subject, it’s common to push a WIP (Work In Progress) commit to a remote branch to save the current state. However, this can clutter the version control history if a proper commit is not made later.

To ensure clean and meaningful commit history, the system should automatically block any subsequent “standard” commit after a WIP commit. This will encourage developers to replace the WIP commit with one or more improved commits.

Proposed Solution:
• Automatic Blocking: After pushing a WIP commit, the system should block subsequent commits.
• Reset Prompt: Developers should be required to run the equivalent of git reset --soft HEAD~1 to remove the WIP commit.
• Guidance: Provide instructions or reminders for developers to create one or more meaningful commits to replace the WIP commit.

Benefits:
• Enforces clean and organized version control history.
• Prevents accidental retention of WIP commits in the final branch.
• Encourages developers to maintain proper commit hygiene.

Additional Considerations:
• Clearly define how the system recognizes a “WIP commit” (e.g., based on commit message patterns like WIP:).
• Add configuration options for teams to customize this behavior if needed.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are identified. Start by locating the CLI code that creates or validates commits and determine how commit messages and configuration are handled. Done means WIP commits are recognized, subsequent standard commits are blocked, and users receive reset and replacement guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, rust
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.