v1.0.0
Release v1.0.0 - Gitt: A CLI for Better Commit Messages
🚀 Introduction
gitt is a command-line interface (CLI) tool that helps you write better commit messages. By providing a structured way to select commit types and enter commit messages, it simplifies and enhances the commit process.
🌟 Features
- Select commit types from a predefined list.
- Choose specific files to add to the commit or add all changes.
- Automatically format commit messages based on the selected type.
📦 Prerequisites
Before installing gitt, ensure you have the following dependencies installed:
- Git
- fzf
🛠️ Installation
To install gitt, follow these steps:
- Clone the repository.
- Run the installation script:
This will install
chmod +x install.sh ./install.sh
gittto/usr/local/bin/.
📖 Usage
To use gitt, simply run the following command in your terminal:
gittFollow the prompts to select files, choose a commit type, and enter your commit message.
📝 Commit Types
| Commit Type | Description |
|---|---|
| no type | No specific type selected; use when the change is minor or unclear. |
| feat | A new feature |
| fix | A bug fix |
| chore | Routine tasks and maintenance |
| refactor | Code changes that do not affect functionality |
| docs | Documentation changes |
| style | Formatting changes (no code change) |
| test | Adding or updating tests |
| perf | Performance improvements |
| ci | Changes related to continuous integration |
| build | Changes related to the build process |
| revert | Reverting previous changes |
🙏 Acknowledgments
This project was inspired by the work of Sina Bayandorian, whose project gitt provided valuable insights into creating a CLI for better commit messages.
🤝 Contributing
Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.