Skip to content

A Python tool that generates clean, conventional commit messages interactively perfect for polished Git workflows and professional history

Notifications You must be signed in to change notification settings

ConzShift/commit-message-generator

Repository files navigation

Commit Message Generator 📝

A Python tool that enforces clean, professional commit histories using the Conventional Commits standard.
This project is meta it can even commit itself using the messages it generates!

🚀 Features

  • Prompt-based commit message generator (type, scope, description)
  • Supports Conventional Commits format
  • Handles breaking changes with proper annotation
  • Optionally auto-stages changes and runs git commit
  • Multiline commit message support (via temp file)
  • Clear feedback with ✅ / ❌ indicators

📦 Installation

git clone https://github.com/ConzShift/commit-message-generator.git
cd commit-message-generator

▶️ Usage 🖥️

python commit_message_generator.py

Follow the prompts to generate a commit message and optionally commit directly.

💡 Example

[Insert screenshot or GIF here]

🎯 Why This Project

  • Enforces commit consistency across projects
  • Saves time writing commit messages
  • Demonstrates orchestration skills and AI-assisted tooling
  • Recruiter-friendly: clean commit histories showcase professionalism
  • Meta milestone: the app can commit itself!

🌟 Roadmap

  • AI-powered commit suggestions
  • Export commit history as PDF/PNG
  • Recruiter-friendly badges and summaries

About

A Python tool that generates clean, conventional commit messages interactively perfect for polished Git workflows and professional history

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages