Skip to content

feat: add --hint flag to provide context#111

Merged
rm-hull merged 5 commits into
mainfrom
feat/hint-flag
May 24, 2026
Merged

feat: add --hint flag to provide context#111
rm-hull merged 5 commits into
mainfrom
feat/hint-flag

Conversation

@rm-hull
Copy link
Copy Markdown
Owner

@rm-hull rm-hull commented May 24, 2026

Introduced a new -H/--hint flag to allow users to provide additional contextual guidance for the commit message generation. This hint is appended to the prompt sent to the LLM to improve the relevance of the generated summary.

Fixes: #105

Introduced a new `-H/--hint` flag to allow users to provide additional
contextual guidance for the commit message generation. This hint is
appended to the prompt sent to the LLM to improve the relevance of the
generated summary.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 24, 2026

TestsPassed ✅SkippedFailed
JUnit Test Report56 ran56 passed0 skipped0 failed
TestResult
JUnit Test Report
com/rm-hull/git-commit-summary/internal/config.TestLoad/Defaults✅ passed
com/rm-hull/git-commit-summary/internal/config.TestLoad/WithEnvironmentVariables✅ passed
com/rm-hull/git-commit-summary/internal/config.TestLoad✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/handle_empty_quoted_strings✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/empty_file,_add_new_properties✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/existing_file,_update_properties✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/doesnt_overwrite_values_if_new_value_is_the_same✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/existing_file,_add_new_and_update_existing✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/preserve_comments_and_other_lines✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/handle_mixed_quoting_styles✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/empty_props,_no_changes✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties/properties_with_special_characters✅ passed
com/rm-hull/git-commit-summary/internal/config.Test_updateProperties✅ passed
com/rm-hull/git-commit-summary/internal/git.TestClient_prepareCommitMessage/Single_line_message_with_skipCI✅ passed
com/rm-hull/git-commit-summary/internal/git.TestClient_prepareCommitMessage/Multi-line_message_with_skipCI✅ passed
com/rm-hull/git-commit-summary/internal/git.TestClient_prepareCommitMessage/Single_line_message_without_skipCI✅ passed
com/rm-hull/git-commit-summary/internal/git.TestClient_prepareCommitMessage/Multi-line_message_without_skipCI✅ passed
com/rm-hull/git-commit-summary/internal/git.TestClient_prepareCommitMessage/Empty_message_with_skipCI✅ passed
com/rm-hull/git-commit-summary/internal/git.TestClient_prepareCommitMessage✅ passed
com/rm-hull/git-commit-summary/internal/llm_provider.TestNewProvider/GoogleProvider✅ passed
com/rm-hull/git-commit-summary/internal/llm_provider.TestNewProvider/OpenAIProvider✅ passed
com/rm-hull/git-commit-summary/internal/llm_provider.TestNewProvider/UnknownProvider✅ passed
com/rm-hull/git-commit-summary/internal/llm_provider.TestNewProvider✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/NewHistory✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Add_and_Value✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Undo✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Redo✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Undo_at_beginning✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Redo_at_end✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Add_truncates_future_history✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory/Multiple_Undos_and_Redos✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestHistory✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/tea.KeyMsg_-_CtrlC_in_showSpinner_state✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/tea.KeyMsg_-_CtrlC_in_other_states✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/gitCheckMsg_-_empty_(no_staged_changes)✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/gitCheckMsg_-_non-empty_(staged_changes)✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/gitDiffMsg_with_hint✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/llmResultMsg_-_with_user_message✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/llmResultMsg_-_without_user_message✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/commitMsg✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/regenerateMsg✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/userResponseMsg✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/cancelRegenPromptMsg✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/errMsg✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/abortMsg✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/spinner.Update_for_showSpinner_state✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/commitView.Update_for_showCommitView_state✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/promptView.Update_for_showRegeneratePrompt_state✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/llmResultMsg_-_YOLO_mode✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update/llmResultMsg_-_YOLO_mode_-_empty_summary✅ passed
com/rm-hull/git-commit-summary/internal/ui.TestModel_Update✅ passed
com/rm-hull/git-commit-summary/internal/version.TestCheckLatestReturnsLatestWhenNewer✅ passed
com/rm-hull/git-commit-summary/internal/version.TestCheckLatestReturnsEmptyWhenUpToDate✅ passed
com/rm-hull/git-commit-summary/internal/version.TestCheckLatestReturnsEmptyForDevel✅ passed
com/rm-hull/git-commit-summary/internal/version.TestCheckLatestWithRevSuffix✅ passed
com/rm-hull/git-commit-summary/internal/version.TestCheckLatestWithRevSuffixAndUpToDate✅ passed

@coveralls
Copy link
Copy Markdown

coveralls commented May 24, 2026

Coverage Report for CI Build 26369786331

Warning

No base build found for commit ce9cdf6 on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 33.659%

Details

  • Patch coverage: 5 uncovered changes across 2 files (4 of 9 lines covered, 44.44%).

Uncovered Changes

File Changed Covered %
main.go 3 0 0.0%
internal/app/app.go 2 0 0.0%

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 1126
Covered Lines: 379
Line Coverage: 33.66%
Coverage Strength: 0.37 hits per line

💛 - Coveralls

Update documentation to include the new `--hint` flag, allowing users to
 provide additional context to the LLM for improved commit message
generation.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new --hint (or -H) CLI flag to provide contextual guidance during commit summary generation. The changes include updating the application's Run method, the UI model, and the prompt generation logic to incorporate this hint. Feedback from the review suggests using simple string concatenation instead of fmt.Sprintf for basic string assembly to follow Go idioms. Additionally, several redundant comments in the test suite were identified for removal to comply with the project's style guide regarding obvious code explanations.

Comment thread internal/ui/model.go
Comment thread internal/ui/model_test.go Outdated
Comment thread internal/ui/model_test.go Outdated
rm-hull and others added 3 commits May 24, 2026 19:40
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Replace `fmt.Sprintf` with simple string concatenation to improve
performance in the summary generation loop.
@rm-hull rm-hull merged commit 7a6ea0b into main May 24, 2026
3 checks passed
@rm-hull rm-hull deleted the feat/hint-flag branch May 24, 2026 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add --hint flag for contextual generation guidance

2 participants