,--.                                                            
             ,--/  /|                   ____            ____             ___     
          ,---,': / '                 ,'  , `.        ,'  , `.  ,--,   ,--.'|_   
          :   : '/ /   ,---.       ,-+-,.' _ |     ,-+-,.' _ |,--.'|   |  | :,'  
          |   '   ,   '   ,'\   ,-+-. ;   , ||  ,-+-. ;   , |||  |,    :  : ' :  
          '   |  /   /   /   | ,--.'|'   |  || ,--.'|'   |  ||`--'_  .;__,'  /   
          |   ;  ;  .   ; ,. :|   |  ,', |  |,|   |  ,', |  |,,' ,'| |  |   |    
          :   '   \ '   | |: :|   | /  | |--' |   | /  | |--' '  | | :__,'| :    
          |   |    ''   | .; :|   : |  | ,    |   : |  | ,    |  | :   '  : |__  
          '   : |.  \   :    ||   : |  |/     |   : |  |/     '  : |__ |  | '.'| 
          |   | '_\.'\   \  / |   | |`-'      |   | |`-'      |  | '.'|;  :    ; 
          '   : |     `----'  |   ;/          |   ;/          ;  :    ;|  ,   /  
          ;   |,'             '---'           '---'           |  ,   /  ---`-'   
          '---'                                                ---`-'            

Kommit

Kommit is a CLI tool to assist with the process of creating good concise commit messages.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• 

(back to top)

Getting Started

To be decided

Prerequisites

Before you can use the CLI tool, make sure you have the following installed:

• Rust - The programming language for building the CLI tool
• Cargo - Rust’s package manager (it comes bundled with Rust)

Usage

(back to top)

1. Clone the repo:

   git clone https://github.com/R3dthefirst/kommit.git

2. Navigate into the project directory:

  cd kommit

3. Build the project using Cargo:

  cargo build --release

4. Install the tool globally (optional, if you want it available system-wide):

  cargo install --path .

5. Run the tool to generate commit messages:

  kommit

Roadmap

• Clean CLI Menu
• Meaningful error messages

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

R3d - r3dthefirst@gmail.com - Discord potassiumcn

Project Link: https://github.com/R3dTheFirst/Kommit

(back to top)

Acknowledgments

• othneildrew

(back to top)