Skip to content

Commit 396672b

Browse files
committed
.
1 parent 3da156d commit 396672b

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

tools/commit_slider/dev_guideline.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
## CS workflow with template
12
```mermaid
23
sequenceDiagram
34
participant User
@@ -21,4 +22,31 @@ sequenceDiagram
2122
Commit Path->>Mode: Commit path with details about each passed commit
2223
Template-->>Mode: Representative function
2324
Mode->>User: Formatted output
24-
```
25+
```
26+
27+
## CS workflow without template (pure configuration)
28+
```mermaid
29+
sequenceDiagram
30+
participant User
31+
participant Config Manager
32+
participant Mode
33+
participant Traversal
34+
participant Commit Path
35+
User->>Config Manager: Runs commit_slider.py with configuration
36+
Note right of User: Validates and prepares configuration,<br>Mode and Traversal are determined by User directly
37+
Config Manager->>Mode: Prepares config. (normalization)
38+
Note right of Config Manager: Absolutizes pathes, checks config. consistency
39+
loop MainLoop
40+
Traversal->>Mode: Slides to another commit
41+
Mode->>Traversal: Resolves current commit
42+
Traversal->>Commit Path: Populates by current commit
43+
end
44+
Note right of Commit Path: Mode appends additional info,<br>corresponding commit state and target task
45+
Commit Path->>Mode: Commit path with details about each passed commit
46+
Mode->>User: Formatted output
47+
```
48+
49+
## Main Loop
50+
### Cfg preparation (rules)
51+
### Mode - Traversal interaction
52+
### Population of CommitPath

0 commit comments

Comments
 (0)