The Commit AI Visual Studio Code extension is a powerful tool that allows users to effortlessly generate commit messages using popular commit message norms through the OpenAI API. With this extension, you can streamline your code commit process, ensuring that your version control history is organize
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
The Commit AI Visual Studio Code extension is a powerful tool that allows users to effortlessly generate commit messages using popular commit message norms through the OpenAI API. With this extension, you can streamline your code commit process, ensuring that your version control history is organized and informative.
📋 Features
Generate commit messages using popular commit message norms.
Access the extension through a dedicated button in the Source Control tab.
Customize your commit message generation by adjusting various settings:
Choose from different AI models.
Adjust the AI temperature for message creativity.
Modify the prompt for generating the commit message.
Set a maximum limit for AI-generated tokens.
⚙ Requirements
[!IMPORTANT]
Before using the Commit AI extension, ensure that you have the following prerequisites installed:
Git: You need Git installed on your system to use this extension. If Git is not installed, you can download it from Git's official website.
OpenAI API Key: To interact with the OpenAI API and utilize its capabilities for generating commit messages, you must have an API key. If you don't have one, sign up for an OpenAI account and obtain your API key from the OpenAI platform.
💾 Installation
Open Visual Studio Code (VS Code).
Go to the Extensions view by clicking on the square icon in the left sidebar or pressing Ctrl+Shift+X.
Search for commit ai generator in the Extensions Marketplace.
Click the "Install" button for the "Commit AI Generator" extension.
🛠 Configuration
After installing the extension, you need to configure it with your OpenAI API key. Follow these steps:
Open VS Code.
Click on the gear icon in the lower-left corner to open the Settings.
Search for "Commit AI Generator" in the settings search bar.
Enter your OpenAI API key in the designated field.
[!NOTE]
Optionally, adjust other settings such as the AI model, temperature, prompt, and maximum token limit to suit your preferences.
✍ Usage
Open a workspace that contains a Git repository.
Navigate to the Source Control tab in the sidebar.
You'll find a "Commit AI Generator" button alongside the usual Git commit options.
Click on the "Commit AI Generator" button to generate a commit message based on your code changes and the configured settings.
🐞 Feedback and Issues
If you encounter any issues or have suggestions for improving the Commit AI extension, please visit the GitHub repository and create an issue. Your feedback is valuable in enhancing the extension's functionality.
Thank you for using the Commit AI Visual Studio Code extension! We hope this tool helps you create informative and standardized commit messages effortlessly. If you have any questions or need further assistance, feel free to reach out to us. Happy coding!
