Skip to content

Commit 4a46350

Browse files
committed
Update README.md
1 parent aea905a commit 4a46350

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,38 @@
44

55
**git-intent** is a Git workflow tool designed for creating [intentional commits](https://intentionalcommits.org/).
66

7-
### Why git-intent?
7+
## Why git-intent?
88

99
Most developers write code first and craft commit messages as an afterthought. This practice often leads to large, unclear, and unfocused commits. Inspired by the Test-Driven Development (TDD) approach, git-intent encourages defining clear intentions before you begin coding, transforming your commit process into a proactive part of development.
1010

11-
1211
By focusing on your intentions upfront, git-intent enables you to:
12+
1313
- Maintain a clean, easily navigable commit history
1414
- Clearly communicate your development intentions
1515
- Prevent scope creep and maintain atomic changes
1616
- Enhance collaboration and project maintainability
1717

1818
> Special thanks to [Joohoon Cha](https://github.com/jcha0713) for introducing the [Intent-Driven Git Workflow](https://youtu.be/yDRs4Pl1Lq0?feature=shared) concept.
1919
20+
## Workflow
21+
22+
```mermaid
23+
flowchart LR
24+
A[Define Intent] -->|git intent add| B[Start Work]
25+
B -->|git intent start| C[Code]
26+
C -->|git intent commit| A
27+
28+
subgraph "Optional Actions"
29+
D[Divide Intent]
30+
E[Cancel Intent]
31+
F[Drop Intent]
32+
end
33+
34+
C -.->|git intent divide| D
35+
C -.->|git intent cancel| E
36+
A -.->|git intent drop| F
37+
```
38+
2039
## Quick Start
2140

2241
```bash

0 commit comments

Comments
 (0)