Commit Sense is a VS Code extension that analyzes code changes and automatically generates meaningful commit messages using OpenAI's GPT models, streamlining the version control process for developers.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Commit Sense is a revolutionary VS Code extension designed to enhance developers' Git workflow. By leveraging OpenAI's cutting-edge GPT models, it intelligently analyzes code changes and automatically generates meaningful and consistent commit messages. This improves version control quality and streamlines team collaboration.
Key Features 🌟
AI-Powered Commit Message Generation 🤖: Deep analysis of staged changes to suggest accurate and detailed commit messages
Multi-language Support 🌍: Generate commit messages in English, 한국어, 日本語, 中文, Español, Français, and more
Smart Commit Types and Emojis 🏷️: Automatically recommend commit types and emojis that suit your project's nature
Customized Detailed Descriptions 📝: Option to provide clear explanations of code change intentions and impacts
Flexible Custom Prompts 🎨: Support for user-defined prompts tailored to your team's commit conventions
Various GPT Model Options 🔧: Choose from GPT-3.5-turbo to the latest GPT-4o, based on your project needs
Installation Requirements 📋
VS Code 1.29.0 or higher
OpenAI API key
Git
Configuration ⚙️
Setting
Description
commitSense.general.openaiApiKey
OpenAI API key
commitSense.general.model
GPT model to use
commitSense.general.language
Commit message language
commitSense.commitMessage.useCommitTypes
Use commit types
commitSense.commitMessage.useEmojis
Use emojis
commitSense.commitMessage.commitTypesWithEmojis
Customize commit types and emojis
commitSense.commitMessage.addDetailedDescription
Add detailed description
commitSense.customPrompt.useCustomPrompt
Use custom prompt
commitSense.customPrompt.prompt
Custom prompt content
How to Use 🚀
Stage changes in your Git repository.
Run "Commit Sense: Generate Commit Message" from the command palette (F1 or Ctrl+Shift+P)
Review and fine-tune the AI-suggested commit message if necessary
Complete the intelligent commit with a single click
Why Choose Commit Sense? 🤔
Time-Saving ⏱️: Significantly reduce the time spent crafting meaningful commit messages.
Consistency 🔄: Maintain a uniform commit message style across your entire team.
Improved Code Reviews 👀: Streamline the code review process with detailed and clear commit messages.
Enhanced Project History 📚: Make your project's change history more comprehensible.
AI-Powered 🧠: Modernize your development workflow by harnessing the latest AI technology.
Start your smarter and more efficient Git experience with Commit Sense today! 🎉
Release Notes 📝
0.0.1
Initial release 🚀
Basic commit message generation functionality
Multi-language support 🌍
Custom prompt feature 🎨
Contributing 🤝
Bug reports, feature requests, and pull requests are welcome. Please check the project's contribution guidelines before contributing.
License 📄
This project is proprietary and confidential. Unauthorized copying, transferring or reproduction of the contents of this project, via any medium, is strictly prohibited.
