GitGuard

Where sloppy commits meet their match.

Dive Into the World of GitGuard!

Welcome to GitGuard, the superhero of commit messages! Imagine a world where every commit message is clear, concise, and follows the sacred rules of Conventional Commits. That's the world GitGuard creates. Let's embark on a journey through its awesome features!

Why GitGuard Rocks:

  • Language Agnosticism: Whether you're coding in Python, rustling up some Rust, or juggling JavaScript, GitGuard speaks your language. Perfect for bilingual codebases!
  • Buddy with Git: Hooks right into Git's commit-msg hook, like a sidekick for your commits, ensuring they're always up to the mark.
  • Customize Your Rules: Although still on the drawing board, imagine setting your own commit commandments! (Coming soon!)
  • Cross-Platform Champion: Tested in the harsh terrains of Linux, but fear not, Windows and macOS users, compatibility is on the horizon!
  • Feedback Friend: Get gentle nudges instead of hard knocks when your commit messages stray off the path.
  • Setup Simplicity: Easy-peasy installation, so you can spend more time coding and less time configuring.

Embrace GitGuard, and turn your commit messages from a mundane task into a harmonious symphony of clarity and consistency. Ready to revolutionize your repository? GitGuard is your go-to guardian!

Setup GitGuard

  1. Download Git-Guard in the root of the repo
    wget https://github.com/segin-GH/gitGuard/raw/main/dist/gitguard.zip
  2. Unzip gitguard.zip
    unzip gitguard.zip
  3. Remove gitguard.zip
    rm gitguard.zip
  4. Change dir to .gitguard
    cd .gitguard
  5. Install gitguard
    ./gitguard.py