Skip to content

Commit 2bb5480

Browse files
authored
Update README.md
1 parent 389ed19 commit 2bb5480

File tree

1 file changed

+48
-36
lines changed

1 file changed

+48
-36
lines changed

README.md

Lines changed: 48 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ The commands in Gitmini are intuitively named, even for users unfamiliar with Gi
1313
## Usage
1414

1515

16-
The main command in GitMini is `git publish`, which simplifies the process of publishing code changes. Use the following syntax to execute the command:
17-
18-
19-
`git publish "name of ticket"`
16+
The main command in GitMini is `git publish`, which simplifies the process of publishing code changes. Use if after working on the repo like this:
2017

18+
```bash
19+
git publish "Ticket name/number"
20+
```
2121

2222
When executed, the git publish command automates the following actions:
2323
- Safely updates your local repository with `git update`
@@ -28,9 +28,9 @@ When executed, the git publish command automates the following actions:
2828

2929
(Soon, an option to create a merge request instead of directly pushing to the master branch will be added.)
3030

31-
32-
`git unpublish "name of ticket"`
33-
31+
```bash
32+
git unpublish "Ticket name/number"
33+
```
3434
When executed, the git publish command automates the following actions:
3535
- Safely updates your local repository with `git update`
3636
- Asks you to fix conflicts if they're present
@@ -44,9 +44,9 @@ Git unpublish is still under work
4444

4545
### Optional Commands
4646

47-
48-
`git start "name of ticket"`
49-
47+
```bash
48+
git start "name of ticket"
49+
```
5050

5151

5252

@@ -55,9 +55,11 @@ The git start command begins work on a new ticket. It performs the following act
5555
- Prompts you to resolve any conflicts, if present.
5656
- Prepare name of ticket as commit message when publishing with git publish (usefult for a future jira integration, name defaults to WIP-currentdate when no specified)
5757

58+
In case you forgot doing it, you can start working on a ticket after you edited some files. They will published when you git publish
5859

59-
`git update`
60-
60+
```bash
61+
git update
62+
```
6163

6264

6365

@@ -69,9 +71,9 @@ git update is used everytime we start or publish a ticket. It automates the foll
6971
- Applies your changes again `git stash pop`
7072

7173
In the future it will be possible to run update every n seconds to be always updated and receive conflicts as soon as possible.
72-
73-
`git current`
74-
74+
```bash
75+
git current
76+
```
7577
Returns the name of the current ticket you're working on, in case your forgot.
7678

7779

@@ -87,7 +89,7 @@ That's it! You have added the aliases to your Git configuration. You can now use
8789

8890
## Aliases
8991

90-
```
92+
```bash
9193
[alias]
9294
start = "!f() { \
9395
git add . && \
@@ -166,45 +168,55 @@ reload = "!rm -f .git/commit-message 2>/dev/null && echo 'Commit message file su
166168

167169
### Minimal Approach
168170
Edit files in repository and then
169-
`git publish ticket-45`
171+
```bash
172+
git publish ticket-45
173+
```
170174

171175
or
172-
173-
`git start "work on the new login page"`
176+
```bash
177+
git start "work on the new login page"
178+
```
174179

175180
Edit files in repository and then
176-
177-
`git publish`
178-
181+
```bash
182+
git publish
183+
```
179184

180185

181186
### Multitasking
182-
183-
`git start feature-1`
184-
187+
```bash
188+
git start feature-1
189+
```
185190
Do your work...
186191

187192
Blocked? Start a new ticket!
188193

189-
`git start feature-2`
194+
```bash
195+
git start feature-2
196+
```
190197

191198
More urgent ticket? Work on that!
192199

193-
`git start bug-1`
200+
```bash
201+
git start bug-1
202+
```
194203

195204
Do your work...
196-
197-
`git publish`
198-
205+
```bash
206+
git publish
207+
```
199208
Go back to feature-1
200-
`git start feature-1`
201-
209+
```bash
210+
git start feature-1
211+
```
202212
Go back to feature-2
203-
`git start feature-2`
204-
205-
**Publish the remaining tickets**
206-
213+
```bash
214+
git start feature-2
215+
```
216+
**Publish the remaining tickets when completed**
217+
```bash
207218
`git publish feature-1`
219+
```
208220

209221
`git publish feature-2`
210222

0 commit comments

Comments
 (0)