commitgenie README

This extension provides developers with a unique way to generate Git commit messages using AI based on the changes staged for commit. Once installed, it leverates the power of OpenAI's GPT model to analyze your code changes and produce a succinct and meaningful commit message.

Features

• AI-Powered Commit Messages: Automatically generate commit messages that adhere to conventional commit standards using GPT AI models.
• Simple Usage: Effortlessly create commit messages directly within VSCode without the need for crafting messages manually.
• Integration with Git: Works smoothly within your existing Git workflow in VSCode.

Requirements

This extension requires access to simple-git and OpenAI node modules. Make sure you have installed them via npm or they are present in your node_modules directory.

Extension Settings

This extension does not have configurable settings as of now.

Usage

To use the extension, follow the steps below:

1. Stage your files for commit in your Git repository.
2. Invoke the commitgenie.commitgenie command from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
3. If there are staged changes, the extension will trigger AI to generate a commit message.
4. Review the generated commit message and complete the commit.

Known Issues

Currently, there are no reported issues.

Release Notes

1.0.0

Initial release of commitgenie.

Added

• Generating commit messages using AI.
• Basic support for generating commit messages for staged changes.

Contributing

Got a suggestion? Open an issue or a pull request on our GitHub repository.

License