di-sukharev / di-sukharev/opencommit

Option to edit the commit before accepting

Open
#81 4 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
7.5k
Forks
445
Avg merge
18m
Merged PRs (30d)
2

Description

The current prompt summarizes all changes in several CC commits. This is not very helpful when skimming the gitlog, as information gets lost. Also the the CC Website suggests to only use one type.

What do I do if the commit conforms to more than one of the commit types?
Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.

FAQ from ConventionalCommits

In addition to sort the text by importance - like Issue #71 suggested - I would like to see the first line summarize the changes in their entirety and/or give me the possibility to edit the text instead of just accepting or rejecting it.

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

No file, test, or entry point is named in the issue. Start by tracing the CLI prompt flow that summarizes changes and offers accept or reject, then determine where an edit option belongs. Done means users can revise the generated commit text before accepting it while retaining the existing accept and reject choices.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, javascript
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.