feat(gitcommit): add commit history context for message generation #9

jinzhongjia · 2025-07-14T05:35:48Z

introduce use_commit_history and commit_history_count options to include recent commit messages as context
update generator to pass commit history to LLM prompt for improved style consistency
implement Git.get_commit_history to retrieve recent commit messages from git log
update configuration, types, and example config to support and document the new feature
ensure commit history context is used across buffer, init, and generator modules

- introduce `use_commit_history` and `commit_history_count` options to include recent commit messages as context - update generator to pass commit history to LLM prompt for improved style consistency - implement `Git.get_commit_history` to retrieve recent commit messages from git log - update configuration, types, and example config to support and document the new feature - ensure commit history context is used across buffer, init, and generator modules

gemini-code-assist

Summary of Changes

Hello @jinzhongjia, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant enhancement to the gitcommit extension by enabling the use of recent commit history as context for LLM-generated commit messages. The primary goal is to improve the consistency and quality of generated messages by allowing the AI to learn from the project's existing commit style, tone, and format, leading to more coherent and contextually relevant suggestions.

Highlights

Enhanced LLM Context for Commit Messages: Introduced new configuration options (use_commit_history and commit_history_count) to allow the LLM to consider recent commit messages as context when generating new ones.
Improved Style Consistency: The LLM prompt now incorporates a configurable number of past commit messages, guiding the model to generate new messages that align with the project's established commit style and format.
Git History Retrieval: Implemented a new utility function (Git.get_commit_history) to efficiently retrieve recent commit messages directly from the Git log, supporting the new context feature.
Broad Integration: The commit history context is seamlessly integrated across the buffer, init, and generator modules, ensuring the feature is available wherever commit messages are generated.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a valuable feature to use commit history as context for generating new commit messages, which should improve consistency. The implementation is mostly solid, but there are a few areas that need attention to maintain code quality, particularly regarding type definitions and code duplication.

gemini-code-assist · 2025-07-14T05:38:41Z

lua/codecompanion/_extensions/gitcommit/types.lua

+---@field use_commit_history? boolean Enable using commit history as context (default: true)
+---@field commit_history_count? number Number of recent commits to include as context (default: 10)


The structure of this type definition file has been modified. The ---@meta directive and the ---@class CodeCompanion.GitCommit.Extension definition were removed, which will break type analysis for language servers. Please restore the file's structure and correctly place the new fields.

gemini-code-assist · 2025-07-14T05:38:41Z

lua/codecompanion/_extensions/gitcommit/generator.lua

+     history_context = "\nRECENT COMMIT HISTORY (for style reference):\n"
+     for i, commit_msg in ipairs(commit_history) do
+       history_context = history_context .. string.format("%d. %s\n", i, commit_msg)
+     end
+     history_context = history_context .. "\nAnalyze the above commit history to understand the project's commit style, tone, and format patterns. Use this as guidance to maintain consistency.\n"


Using string concatenation (..) inside a loop can be inefficient in Lua. It's recommended to build a table of strings and then use table.concat for better performance.

local history_parts = { "\nRECENT COMMIT HISTORY (for style reference):\n" } for i, commit_msg in ipairs(commit_history) do table.insert(history_parts, string.format("%d. %s\n", i, commit_msg)) end history_context = table.concat(history_parts) .. "\nAnalyze the above commit history to understand the project's commit style, tone, and format patterns. Use this as guidance to maintain consistency.\n"

gemini-code-assist · 2025-07-14T05:38:42Z

lua/codecompanion/_extensions/gitcommit/git.lua

@@ -4,11 +4,11 @@ local Git = {}
 -- Store configuration
 local config = {}

---Setup Git module with configuration
---@param opts? table Configuration options
 function Git.setup(opts)


The documentation for the Git.setup function was removed. It's good practice to keep functions documented for clarity.

---Setup Git module with configuration ---@param opts? table Configuration options function Git.setup(opts)

gemini-code-assist · 2025-07-14T05:38:42Z

lua/codecompanion/_extensions/gitcommit/init.lua

+    local commit_history = nil
+    local git_config = Git.get_config and Git.get_config() or {}
+    if git_config.use_commit_history then
+      commit_history = Git.get_commit_history(git_config.commit_history_count)
+    end


This block of code to retrieve commit history is duplicated in the exports.generate function (lines 310-314). Consider extracting this logic into a local helper function to avoid redundancy.

gemini-code-assist · 2025-07-14T05:38:42Z

lua/codecompanion/_extensions/gitcommit/init.lua

+
+    -- Get commit history if enabled
+    local commit_history = nil
+    local git_config = Git.get_config and Git.get_config() or {}


The check Git.get_config and Git.get_config() or {} is overly defensive. Since Git.get_config() is guaranteed to exist within the module and always returns a table, this can be simplified.

local git_config = Git.get_config()

gemini-code-assist · 2025-07-14T05:38:42Z

lua/codecompanion/_extensions/gitcommit/init.lua

+      local commit_history = nil
+      local git_config = Git.get_config and Git.get_config() or {}
+      if git_config.use_commit_history then
+        commit_history = Git.get_commit_history(git_config.commit_history_count)
+      end


This logic for retrieving commit history is a duplicate of the code in M.generate_commit_message (lines 37-41). Please consider refactoring this into a shared helper function.

gemini-code-assist · 2025-07-14T05:38:42Z

lua/codecompanion/_extensions/gitcommit/init.lua

@@ -294,8 +306,15 @@
        return callback(nil, "No staged changes found. Please stage your changes first.")
      end

+      -- Get commit history if enabled
+      local commit_history = nil
+      local git_config = Git.get_config and Git.get_config() or {}


This check Git.get_config and Git.get_config() or {} is overly defensive and is also used elsewhere. Git.get_config() will always return a table, so the checks are redundant. This can be simplified.

local git_config = Git.get_config()

- update indentation and spacing across gitcommit extension files - fix minor comment alignment and trailing comma issues in config example - standardize function parameter documentation and formatting

- move generate_commit_message function from Git class to proper Generator class - add missing get_commit_history function declaration to Git class - fix indentation and formatting issues in type annotations

- delete extraneous blank line for improved code readability

- consolidate EXTENSION_DEVELOPMENT_GUIDE.md, GEMINI.md, tools.md, and prompt_construction_en.md into codecompanion.txt - update and expand help documentation for plugin features, configuration, extension development, and tool creation - remove outdated and redundant markdown guides in favor of unified vim help file

- update comments and docstrings for clarity and consistency across buffer, generator, git, init, and ui modules - rephrase and simplify inline comments to enhance readability - standardize parameter descriptions and function documentation for better maintainability

- add commit history context feature to README and configuration docs - introduce programmatic API section with usage examples in README and help file - update documentation structure and configuration options for clarity

- introduce codecompanion-workspace.json with schema and group definitions - organize extension components into logical groups for core, git, AI, UI, tools, and docs - provide metadata and file descriptions to support project tooling and documentation

- add documentation for the get_changed_files tool, including usage and options - update tool group listings and examples to include get_changed_files - clarify and expand options for file_search, grep_search, insert_edit_into_file, and next_edit_suggestion tools - update event list with CodeCompanionChatDone event - fix and improve tool group documentation for clarity and completeness

- add checks for nil language selection in commit message generation - prevent further processing if user cancels language selection dialog

gemini-code-assist bot reviewed Jul 14, 2025

View reviewed changes

jinzhongjia mentioned this pull request Jul 14, 2025

Feature Request: Consider historical commit messages for context #8

Open

gemini-code-assist bot reviewed Jul 14, 2025

View reviewed changes

jinzhongjia added 9 commits July 14, 2025 13:39

refactor(gitcommit): improve formatting and consistency

c1a90b6

- update indentation and spacing across gitcommit extension files - fix minor comment alignment and trailing comma issues in config example - standardize function parameter documentation and formatting

fix(types): correct type declarations for Git and Generator classes

35d3aa4

- move generate_commit_message function from Git class to proper Generator class - add missing get_commit_history function declaration to Git class - fix indentation and formatting issues in type annotations

style(types): remove unnecessary blank line in types.lua

6f845b8

- delete extraneous blank line for improved code readability

docs(gitcommit): document commit history context and API

1d288b6

- add commit history context feature to README and configuration docs - introduce programmatic API section with usage examples in README and help file - update documentation structure and configuration options for clarity

fix(gitcommit): handle cancelled language selection gracefully

cdaf702

- add checks for nil language selection in commit message generation - prevent further processing if user cancels language selection dialog

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(gitcommit): add commit history context for message generation #9

feat(gitcommit): add commit history context for message generation #9

Uh oh!

jinzhongjia commented Jul 14, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

gemini-code-assist bot Jul 14, 2025

Uh oh!

Uh oh!

		---@field use_commit_history? boolean Enable using commit history as context (default: true)
		---@field commit_history_count? number Number of recent commits to include as context (default: 10)

feat(gitcommit): add commit history context for message generation #9

Are you sure you want to change the base?

feat(gitcommit): add commit history context for message generation #9

Uh oh!

Conversation

jinzhongjia commented Jul 14, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!