https://github.com/jackall3n/gitter

Ah, I think gitter is already something else
https://github.com/jackall3n/gitter

Last synced: 4 days ago
JSON representation

Ah, I think gitter is already something else

• Host: GitHub
• URL: https://github.com/jackall3n/gitter
• Owner: jackall3n
• Created: 2022-07-08T13:15:26.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T20:12:17.000Z (about 1 year ago)
• Last Synced: 2024-11-09T08:42:32.427Z (about 2 months ago)
• Language: Go
• Homepage:
• Size: 116 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 💡 gitter (better name pending)

## Installation

```shell

go install github.com/jackall3n/gitter

```

## Example

![Example](.github/images/checkout.png)

## Usage

### Checkout

`checkout` will use a configuration file to format your branch name

```shell

gitter checkout [ticket] [description]

```

#### With alias

```shell

# ~/.zshrc

alias co="gitter checkout"

```

```shell

co [ticket]

```

### Commit

`commit` will append the ticket from the branch name to the start of the commit message

```shell

gitter commit [message]

```

#### With alias

```shell

# ~/.zshrc

alias cm="gitter cm"

```

```shell

cm [ticket]

```

#### Example

```shell

Development/bulb-git/account  master ✗

▶ co 123

description: Something really important 

Development/bulb-git/account  ja/UAP-123/something-really-important ✗ 

▶ cm

message: The important work

Development/bulb-git/account  ja/UAP-123/something-really-important ✔

▶ git log -1 --oneline

(HEAD -> ja/UAP-123/something-really-important) [UAP-123]: The important work

```

## Configuration

Add a `.gitter.yaml` configuration to your `$HOME` directory, or your project root

```shell

# Global config

touch ~/.gitter.yaml

# Project specific

touch ~/development/special-project/.gitter.yaml

```

#### Example

```yaml

# ~/.gitter.yaml

prefix: ja

board: ABC

```