https://github.com/benst099/firecommit
Python-Script for generating commit-messages
https://github.com/benst099/firecommit
check-commit commit-conventions commit-template commits efficiency git git-commit group-project improvement prettytable py3 python python-3 python3 script standardization template
Last synced: 10 months ago
JSON representation
Python-Script for generating commit-messages
- Host: GitHub
- URL: https://github.com/benst099/firecommit
- Owner: BenSt099
- License: gpl-3.0
- Created: 2023-01-20T18:03:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T16:35:58.000Z (over 2 years ago)
- Last Synced: 2025-01-19T22:18:40.190Z (11 months ago)
- Topics: check-commit, commit-conventions, commit-template, commits, efficiency, git, git-commit, group-project, improvement, prettytable, py3, python, python-3, python3, script, standardization, template
- Language: Python
- Homepage:
- Size: 466 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🔥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](https://www.python.org/downloads/) ]
## Installation
Download the source code ([See latest releases](https://github.com/BenSt099/FireCommit/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:
```bash
python FireCommit.py
```
or
```bash
python3 FireCommit.py
```
## Documentation
For the full documentation, click [here](https://github.com/BenSt099/FireCommit/blob/main/docs/docs.adoc).
## 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
```bash
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](https://github.com/BenSt099/FireCommit/blob/main/LICENSE).