Skip to content

Commit e299003

Browse files
dotrachitactions-user
authored andcommitted
🔧 general: Fix linting with prettier
1 parent 85cabb6 commit e299003

File tree

1 file changed

+41
-42
lines changed

1 file changed

+41
-42
lines changed

USAGE.md

Lines changed: 41 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,45 @@
11
## Gitg0 Usage
22

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:
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:
66
![commit_guideline_image](https://user-images.githubusercontent.com/44428198/101599597-03ad8500-3a20-11eb-9286-125b570c36ca.png)
7-
* Choose if you want **emojis**:
7+
- Choose if you want **emojis**:
88
![emoji_usage_image](https://user-images.githubusercontent.com/44428198/101599916-96e6ba80-3a20-11eb-88e4-d19143793dc8.png)
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-
![github_issue_number_image](https://user-images.githubusercontent.com/44428198/101600253-0eb4e500-3a21-11eb-8a88-41061d6a850d.png)
15-
or **manually type** what you're working:
16-
![manual_issue_text_image](https://user-images.githubusercontent.com/44428198/101600600-90a50e00-3a21-11eb-9401-43744b3260e1.png)
17-
* After we fetch your Github Issue title or process your manually entered text, select the **Issue type**:
18-
![issue_type_mcq_image](https://user-images.githubusercontent.com/44428198/101600846-e37ec580-3a21-11eb-94b6-6b6ab9ff38c1.png)
19-
20-
* To see suggested Branch Name and Commit Title:
21-
* Run `gtg display`:
22-
![suggested_names_image](https://user-images.githubusercontent.com/44428198/101601370-9fd88b80-3a22-11eb-9232-ce189d7c669c.png)
23-
* You can also modify the suggested names by simply entering the text:
24-
![modifying_suggested_name_image](https://user-images.githubusercontent.com/44428198/101601720-ffcf3200-3a22-11eb-873a-22a88ff7d47f.png)
25-
26-
* To checkout to the suggested Branch Name:
27-
* Run `gtg checkout`:
28-
![checkout_branch_image](https://user-images.githubusercontent.com/44428198/101601994-67857d00-3a23-11eb-9879-709b1e6439d6.png)
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-
![git_add_and_git_status_image](https://user-images.githubusercontent.com/44428198/101602602-66a11b00-3a24-11eb-8dde-0e83b3d4123c.png)
36-
37-
* To commit changes with the Gitg0's suggested commit message:
38-
* Run `gtg commit`:
39-
![gtg_commit_image](https://user-images.githubusercontent.com/44428198/101602830-b4b61e80-3a24-11eb-8fa7-d8094deb751a.png)
40-
* [Optional] Run `git log` to ensure that the changes have been commited.
41-
42-
* To push your changes:
43-
* Run `git push`:
44-
![git_push_image](https://user-images.githubusercontent.com/44428198/101603001-eb8c3480-3a24-11eb-8a48-9a583460faeb.png)
45-
46-
* Voila! You're GTG: Good to go.
9+
- A `.gitgo` file will be generated in your working directory!
10+
- Now, whenever you work on a new feature/issue:
11+
- Run `gtg start`
12+
- Either enter your **Github Issue Number**:
13+
![github_issue_number_image](https://user-images.githubusercontent.com/44428198/101600253-0eb4e500-3a21-11eb-8a88-41061d6a850d.png)
14+
or **manually type** what you're working:
15+
![manual_issue_text_image](https://user-images.githubusercontent.com/44428198/101600600-90a50e00-3a21-11eb-9401-43744b3260e1.png)
16+
- After we fetch your Github Issue title or process your manually entered text, select the **Issue type**:
17+
![issue_type_mcq_image](https://user-images.githubusercontent.com/44428198/101600846-e37ec580-3a21-11eb-94b6-6b6ab9ff38c1.png)
18+
- To see suggested Branch Name and Commit Title:
19+
- Run `gtg display`:
20+
![suggested_names_image](https://user-images.githubusercontent.com/44428198/101601370-9fd88b80-3a22-11eb-9232-ce189d7c669c.png)
21+
- You can also modify the suggested names by simply entering the text:
22+
![modifying_suggested_name_image](https://user-images.githubusercontent.com/44428198/101601720-ffcf3200-3a22-11eb-873a-22a88ff7d47f.png)
23+
- To checkout to the suggested Branch Name:
24+
- Run `gtg checkout`:
25+
![checkout_branch_image](https://user-images.githubusercontent.com/44428198/101601994-67857d00-3a23-11eb-9879-709b1e6439d6.png)
26+
- Make relevant changes to your code for your issue.
27+
28+
- To add all changes in the working directory to the staging area (conventional git stuff):
29+
30+
- Run `git add .`
31+
- [Optional] Run `git status` to check the state of the working directory:
32+
![git_add_and_git_status_image](https://user-images.githubusercontent.com/44428198/101602602-66a11b00-3a24-11eb-8dde-0e83b3d4123c.png)
33+
34+
- To commit changes with the Gitg0's suggested commit message:
35+
36+
- Run `gtg commit`:
37+
![gtg_commit_image](https://user-images.githubusercontent.com/44428198/101602830-b4b61e80-3a24-11eb-8fa7-d8094deb751a.png)
38+
- [Optional] Run `git log` to ensure that the changes have been commited.
39+
40+
- To push your changes:
41+
42+
- Run `git push`:
43+
![git_push_image](https://user-images.githubusercontent.com/44428198/101603001-eb8c3480-3a24-11eb-8a48-9a583460faeb.png)
44+
45+
- Voila! You're GTG: Good to go.

0 commit comments

Comments
 (0)