|
| 1 | +## Gitg0 Usage |
| 2 | + |
| 3 | +* Before you start working on your project, set up the `.gitgo` file: |
| 4 | + * Run `gtg config` |
| 5 | + * Choose a **commit guideline** for your project: |
| 6 | +  |
| 7 | + * Choose if you want **emojis**: |
| 8 | +  |
| 9 | + * A `.gitgo` file will be generated in your working directory! |
| 10 | + |
| 11 | + * Now, whenever you work on a new feature/issue: |
| 12 | + * Run `gtg start` |
| 13 | + * Either enter your **Github Issue Number**: |
| 14 | +  |
| 15 | + or **manually type** what you're working: |
| 16 | +  |
| 17 | + * After we fetch your Github Issue title or process your manually entered text, select the **Issue type**: |
| 18 | +  |
| 19 | + |
| 20 | + * To see suggested Branch Name and Commit Title: |
| 21 | + * Run `gtg display`: |
| 22 | +  |
| 23 | + * You can also modify the suggested names by simply entering the text: |
| 24 | +  |
| 25 | + |
| 26 | + * To checkout to the suggested Branch Name: |
| 27 | + * Run `gtg checkout`: |
| 28 | +  |
| 29 | + |
| 30 | + * Make relevant changes to your code for your issue. |
| 31 | + |
| 32 | + * To add all changes in the working directory to the staging area (conventional git stuff): |
| 33 | + * Run `git add .` |
| 34 | + * [Optional] Run `git status` to check the state of the working directory: |
| 35 | +  |
| 36 | + |
| 37 | + * To commit changes with the Gitg0's suggested commit message: |
| 38 | + * Run `gtg commit`: |
| 39 | +  |
| 40 | + * [Optional] Run `git log` to ensure that the changes have been commited. |
| 41 | + |
| 42 | + * To push your changes: |
| 43 | + * Run `git push`: |
| 44 | +  |
| 45 | + |
| 46 | + * Voila! You're GTG: Good to go. |
0 commit comments