https://github.com/alvii147/gitmsg

App for writing git commit messages using 50/72 rule
https://github.com/alvii147/gitmsg

git gitcommit golang pyqt5

Last synced: 3 months ago
JSON representation

App for writing git commit messages using 50/72 rule

• Host: GitHub
• URL: https://github.com/alvii147/gitmsg
• Owner: alvii147
• License: bsd-3-clause
• Created: 2021-06-27T02:05:18.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-11T23:12:11.000Z (6 months ago)
• Last Synced: 2024-08-12T00:23:57.485Z (6 months ago)
• Topics: git, gitcommit, golang, pyqt5
• Language: Python
• Homepage:
• Size: 11.4 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Free Palestine](https://hinds-banner.vercel.app/free-palestine?variant=crimson)](https://www.pcrf.net/)

[![Genocide Watch](https://hinds-banner.vercel.app/genocide-watch?variant=crimson)](https://www.pcrf.net/)



    





gitmsg is an application for writing git commit messages according to the git 50/72 rule.





[![GitHub CI](https://img.shields.io/github/actions/workflow/status/alvii147/gitmsg/github-ci.yml?branch=master&label=Github%20CI&logo=github)](https://github.com/alvii147/gitmsg/actions) [![Go Report Card](https://goreportcard.com/badge/github.com/alvii147/gitmsg/cli)](https://goreportcard.com/report/github.com/alvii147/gitmsg/cli) [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)



## Installation

Clone the repository:

```bash

git clone https://github.com/alvii147/gitmsg.git

```

Setup *gitmsg*:

```bash

cd gitmsg/

./setup.sh

```

Set up alias to script by adding the following to `~/.bashrc` or `~/.bash_profile`:

```bash

alias gitmsg="/absolute/path/to/gitmsg/gitmsg.sh"

```

## Usage

```

gitmsg helps write git commit messages based on the git 50/72 rule.

Usage:

        gitmsg [OPTIONS]

Options:

        -g, run in GUI mode

        -c, run in CLI mode

        -h, show help

```

### GUI Mode

```bash

gitmsg -g

```

![GUI screenshot](img/gui_screenshot.png)

### CLI mode

```bash

gitmsg -c

```

![CLI screenshot](img/cli_screenshot.png)