https://github.com/yegor256/gitted
Custom Git commands and Bash scripts to streamline key operations—with a little help from ChatGPT
https://github.com/yegor256/gitted
git git-flow pip python
Last synced: 6 days ago
JSON representation
Custom Git commands and Bash scripts to streamline key operations—with a little help from ChatGPT
- Host: GitHub
- URL: https://github.com/yegor256/gitted
- Owner: yegor256
- License: mit
- Created: 2025-05-25T22:57:02.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-12-31T15:15:10.000Z (20 days ago)
- Last Synced: 2026-01-04T23:40:29.634Z (16 days ago)
- Topics: git, git-flow, pip, python
- Language: Shell
- Homepage: https://pypi.org/project/gitted/
- Size: 366 KB
- Stars: 11
- Watchers: 0
- Forks: 4
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Command-Line Shortcuts for a Primitive Git Flow
[](https://www.rultor.com/p/yegor256/gitted)
[](https://github.com/yegor256/gitted/actions/workflows/make.yml)
[][pip]
[](https://www.0pdd.com/p?name=yegor256/gitted)
[](https://codecov.io/gh/yegor256/gitted)
[](https://hitsofcode.com/view/github/yegor256/gitted)
[](https://github.com/yegor256/gitted/blob/master/LICENSE.txt)
If all you need to do with Git is make branches, push, and sync,
this collection of command-line commands may simplify your workflow.
Well, it simplifies mine, a [hundred](https://github.com/yegor256)
times per day.
First, install [Python3], [Git], [pip], [gh], and [Bash].
Then, install this Python package (with Bash scripts inside):
```bash
pip install gitted==0.0.19
```
Then, in order to make a contribution to a GitHub repo, assuming
you've made a [fork][fork2] already and cloned it (in the command line):
First, start a branch to resolve issue no. 42 (for example):
```bash
branch 42
```
Then, write some code and add+commit it (no push):
```bash
commit 'Just fixed a small bug'
```
Then, pull recent changes from the `master` of the upstream:
```bash
pull
```
Finally, write more code and add+commit+push it:
```bash
push 'Just fixed a big bug'
```
If you omit the commit message for the `commit` or the `push` command,
they will use ChatGPT to generate it, looking at the changes you've made.
To make it work, define the `OPENAI_API_KEY` environment variable with the
[OpenAI key].
## Conventions
In order to work smoothly, you must respect a few conventions:
* Branch names are always integers, equal to GitHub issue numbers ([why?][nums])
* All commits are GPG-signed, if you have a key ([how?][gpg])
* The `origin` is the fork, while the `upstream` is the main repo ([why?][fork])
Perhaps in future versions we'll make these configurable.
However, at the moment, that's what we have.
## How to Contribute
Install [GNU make] and [uv]. Then, run:
```bash
make
```
Should build.
If it doesn't, submit a bug report.
[GNU make]: https://www.gnu.org/software/make/
[uv]: https://github.com/astral-sh/uv
[Python3]: https://www.python.org/
[Git]: https://git-scm.com/
[pip]: https://pypi.org/project/pip/
[gh]: https://github.com/cli/cli#installation
[Bash]: https://www.gnu.org/software/bash/
[OpenAI key]: https://platform.openai.com/api-keys
[fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork
[gpg]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits
[fork2]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
[nums]: https://www.yegor256.com/2014/04/15/github-guidelines.html