mrshennawy/committer

Manage Git commits effortlessly with the 'Committer'.

v1.0.3 2024-01-06 17:37 UTC

Requires

• php: ^8.0|^8.1
• laravel/prompts: ^0.1.14
• symfony/console: ^4.0|^5.0|^6.0
• symfony/process: ^4.2|^5.0|^6.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^8.0|^9.3

MIT

• Mahmoud Shennawy

• committer
• git-committer

README

**committer** is a Composer package that simplifies the process of writing standard Git commit messages. It helps developers maintain a consistent and clean commit history.

Table of Contents

1. Installation
2. Usage
3. Authors
4. License

Installation

Committer uses Composer to manage its dependencies. Make sure you have Composer installed on your machine before using Committer.

composer global require mrshennawy/committer

You must place Composer's system-wide vendor bin directory in your $PATH so that your system can locate the Committer executable. This directory exists in different locations based on your operating system. Some common locations include:

• macOS: $HOME/.composer/vendor/bin

  • export PATH=$PATH:$HOME/.composer/vendor/bin

• Windows: %USERPROFILE%\AppData\Roaming\Composer\vendor\bin

  • set PATH=%PATH%;%USERPROFILE%\AppData\Roaming\Composer\vendor\bin

• GNU / Linux Distributions: $HOME/.config/composer/vendor/bin or $HOME/.composer/vendor/bin

  • export PATH=$PATH:$HOME/.config/composer/vendor/bin

  or

  • export PATH=$PATH:$HOME/.composer/vendor/bin`
    

You can also find the global installation path of Composer by running composer global about and looking for it in the first line.

Usage

After installing the package, you can use it by running only gc:

• The gc command now supports the following options:
  • --select: This option allows to select the files before committing. It can be used as gc --select or gc -s.
  • --build: This option builds the project before commit. It can be used as gc --build or gc -b.

Authors

• Mahmoud Shennawy | GitHub | LinkedIn | [e-mail]

You can also see the list of contributors who participated in this project.

License

This project is licensed under the MIT License. See the file LICENSE.md for details.