https://github.com/hemmouda/pgt
Your commit messages' prefixes.
https://github.com/hemmouda/pgt
commit git message prefix python script
Last synced: 11 months ago
JSON representation
Your commit messages' prefixes.
- Host: GitHub
- URL: https://github.com/hemmouda/pgt
- Owner: hemmouda
- License: mit
- Created: 2024-07-01T19:12:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-10T13:21:24.000Z (over 1 year ago)
- Last Synced: 2025-02-17T16:43:15.193Z (12 months ago)
- Topics: commit, git, message, prefix, python, script
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pgt 
prefixes for git
Your commit messages' prefixes.
You keep forgetting what prefix to use for what commit?
> `Feat`, `Add`? What should I use? Can I even use `New`??
Does that sound like you sometimes? Not anymore!
This python script keeps a list of all your commit messages' prefixes. You can see all of
them or search for one. The top search result is automatically copied. 😊
## Example:
You are working on your project and you just added a new functionality, but forgot what prefix is the
appropriate one to use. You could see a list of all the known prefixes and use the one you deem fit, like so:
```console
$ pgt
```
Or you could search for prefixes with terms that best describe your commit changes, for example:
```console
$ pgt new feature
```
## How-to:
1. Put the [**pgt**](pgt) script with your other **bin**aries, or in a separate folder, but then don't forget
to include that folder to your **PATH** variable (There are plenty of resources out there if you don't know how to do the latter)
3. Add execution rights to it: ```$ chmod u+x pgt```
4. Rehash to use instantly: ```$ rehash```
## Requirments:
- `python 3.10` or greater
- `pyperclip` module if you want the copying functionality