benst099/firecommit

Python-Script for generating commit-messages

🔥FireCommit

Features

Commandline-Tool

Platform-independent

Modifications possible

Description

In large projects it's important to use verbose and structured commit messages. This can be challenging when working in a big team with many developers. The provided script helps you with that.

Requirements

• Python, Vesion >= 3.7 [ Installation ]

Installation

Download the source code (See latest releases) and unpack them. See Usage for starting the script.

Usage

First, choose the working directory (so where your project's .git-folder is located) by modifiying config.json. It's set to the directory where the script is in (./) by default.

NOTE: Under Windows, you have to escape the backslash (e.g. C:\\User\\Projects\\YourProject\\).

The script was tested on Windows and Linux (MacOS: Not Tested (Works on my machine 😉)). For starting the script, open a terminal / command prompt and type:

python FireCommit.py

or

python3 FireCommit.py

Documentation

For the full documentation, click here.

Known Issues

1. Committing Without Adding

   • The script warns you if some files are unstaged but it doesn't include those files into the commit. You have to manually add them to the staging area.

2. Unexpected Result When Running git log

   • When writing a verbose commit message, a compromise must be made regarding the readability of the git log.

   • If you run git log, you may see a large amount of text that would fill up pages.

   • Using git shortlog will not help:

To search for single commits more easily, use

git log --pretty=format:"%cn committed %h on %cd with Topic: %f"

or similar modifications.

License

This project is licensed under GNU General Public License v3.0. Fore more information, click here.