Skip to content

JuanCamiloGrA/commitmaster-ai

Repository files navigation

CommitMaster AI 🚀

Transform your commit history into a masterpiece of clarity and professionalism. Leverage artificial intelligence to create consistently perfect, educational, and highly detailed commit messages that enhance collaboration and code understanding.

Why CommitMaster AI? 🎯

  • Perfect Commits Every Time: Generate structured, didactic, and detailed commit messages that serve as documentation for your changes.
  • Team Consistency: Maintain a unified commit style across large teams and projects, ensuring every commit follows best practices.
  • Educational Value: Each commit message is crafted to be self-explanatory, helping team members understand not just what changed, but why and how.
  • Time Savings: Focus on coding while letting AI handle the complexity of crafting detailed, conventional commit messages.

Features ✨

  • AI-Powered Semantic Commits: Automatically analyzes code changes to generate contextually accurate and meaningful commit messages.
  • Conventional Commits Excellence: Strictly follows and enforces Conventional Commits specification with perfect formatting.
  • Smart Emoji Integration: Automatically adds relevant emojis to categorize changes visually.
  • Detailed Explanations: Generates both concise summaries and detailed descriptions when needed.
  • Change Impact Analysis: Identifies and documents breaking changes, side effects, and related implications.

Benefits for Teams 🤝

  • Consistency Guarantee: Eliminates inconsistent commit styles across team members.
  • Better Code Reviews: Detailed commit messages make review processes more efficient.
  • Enhanced Documentation: Each commit serves as clear documentation of changes.
  • Onboarding Aid: New team members can better understand project history through descriptive commits.
  • Best Practices Enforcement: Ensures all commits follow industry-standard conventions.

Requirements ⚙️

Configuration 🛠️

  1. Obtain a Gemini API Key from Google AI Studio.
  2. In VS Code, open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
  3. Type "CommitMaster: Configurar API Key de Gemini" and press Enter.
  4. Enter your Gemini API Key.

Usage 💻

  1. Open your project in Visual Studio Code.
  2. Make some changes to your code.
  3. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
  4. Type "CommitMaster: Generar commit" and press Enter.
  5. The CommitMaster AI panel will open with a generated commit message.
  6. Click the "Realizar Commit" button to commit your changes.

Contributing 🤝

Contributions are welcome! Please feel free to submit a pull request.

License 📝

MIT

Credits 🙏

  • This extension is inspired by the need for efficient and consistent commit message generation.
  • Uses the power of Google's Gemini AI.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors