Skip to content

bernabedev/gemcommit

Repository files navigation

🚀 GemCommit - AI-Powered Conventional Commit Generator

GemCommit is a VS Code extension that generates commit messages automatically using Google Gemini AI, following the Conventional Commits specification.

✨ Features

  • 🔥 AI-powered commit message generation based on staged changes.
  • 📝 Follows Conventional Commits (feat, fix, docs, chore, etc.).
  • One-click commit message insertion in the Source Control input.
  • 🖊️ Detailed commit messages with body and breaking changes support.
  • 📜 Commit history tracking for easy reuse of previous messages.
  • 🌐 Supports customization of AI model and API key in settings.
  • 🎨 Seamless integration with VS Code's Source Control UI.

📸 Screenshots

![GemCommit in Action]

📦 Requirements

  • VS Code ^1.97.0
  • Google Gemini AI API Key (see Setup)

⚙️ Setup

  1. Get a Google Gemini API Key from Google AI Studio.
  2. Open VS Code Settings (Ctrl + , or Cmd + , on Mac).
  3. Search for GemCommit.
  4. Add your API Key in gemcommit.apiKey.

🔧 Extension Settings

Setting Description
gemcommit.apiKey API key for Google Gemini AI.
gemcommit.model AI model for generating commit messages.
gemcommit.customPrompt Custom prompt template for commit messages.
gemcommit.promptBeforeInsert Enables review before inserting commit messages.
gemcommit.maxHistorySize Maximum number of commit messages stored in history.
gemcommit.includeProjectContext Includes project details (e.g., package.json) in AI prompts.
gemcommit.commitLanguage Language for commit messages (e.g., english, spanish).

🛠 Commands

Command Description
GemCommit: Generate Commit Message Generates a Conventional Commit message.
GemCommit: Generate Detailed Commit Message Generates a detailed commit with body & scope.
GemCommit: Show Commit History Displays previous commit messages for reuse.

🛠 Known Issues

  • No known issues. Feel free to report any here.

📌 Release Notes

1.0.7

  • AI-powered commit message generation.
  • VS Code Source Control integration.
  • Conventional Commits support.
  • Commit history tracking.
  • Review before inserting commit messages.
  • Support for multiple languages.

📜 Following Extension Guidelines

Make sure to follow the official VS Code Extension Guidelines for best practices.

🎯 Contribution

Contributions are welcome! Fork the repo and submit a PR here.


🔗 More Information:

About

AI-powered Conventional Commit Generator using Google Gemini.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published