refactor(gitcommit): clarify release notes formatrefactor

[jinzhongjia]

No description provided.

[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 refactors the internal prompts used by the gitcommit extension to generate both conventional commit messages and release notes. The changes aim to enhance the quality and consistency of the generated text by providing more explicit, specific, and example-driven instructions to the underlying AI model, ultimately leading to more useful and well-formatted outputs.

Highlights

• Commit Message Generator Prompt Refinement: The prompt for generating conventional commit messages has been significantly updated. It now includes clearer 'CRITICAL RULES' emphasizing specificity, avoiding vague verbs, and providing 'BAD (vague)' and 'GOOD (specific)' examples to guide the AI model towards more precise commit descriptions.
• Release Notes Format Instruction Clarification: Instructions for generating release notes have been refined. The guidance to wrap the entire output in a markdown code block has been moved and made more explicit within the final prompt assembly, ensuring the generated release notes are correctly formatted.
• Prompt Simplification: Several less effective or redundant sections, such as 'CRITICAL FORMAT REQUIREMENTS', 'RULES', and 'COMPLEXITY GUIDE' from the commit message generator prompt, have been removed to streamline instructions and reduce cognitive load on the AI model.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

Footnotes

1. 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 refactors the prompts used for generating git commit messages and release notes, aiming to make them clearer and more directive for the language model. The changes in generator.lua significantly improve the commit message prompt by providing specific instructions on using active verbs and including illustrative good/bad examples. Similarly, the changes in prompts/release_notes.lua clarify the output formatting instructions for release notes by moving them to a more effective location in the prompt. These are positive changes that should improve the quality of the generated content. I have one minor suggestion to enhance code readability in prompts/release_notes.lua.

[gemini-code-assist]

For improved readability and to consolidate what is logically a single block of text, you can combine these table.insert calls into one call using a multiline string. This makes the prompt instruction easier to read and maintain.

  table.insert(parts, [[Generate release notes based on the commits above.

IMPORTANT: Wrap your ENTIRE output in a markdown code block like this:
```markdown
[your release notes here]
```]])