Skip to content

Commit

Permalink
add change graph
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelstroschein committed Oct 7, 2024
1 parent 8989888 commit 7b44e2e
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions lix/packages/sdk/docs/20-concepts/30-change-graph.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Change Graph

```mermaid
graph TB
G["Change G"] --> F["Change D"]
F --> B["Change B"]
F --> C["Change C"]
B --> A["Change A"]
C --> A
```

## Purpose

Represent the relationships and history of changes.

## Examples

### Dependencies

Change B depends on Change A.

```mermaid
graph TB
G["Change G"]:::unhighlight --> F["Change D"]
F["Change D"]:::unhighlight
F --> B["Change B"]
F --> C["Change C"]:::unhighlight
B --> A["Change A"]
C --> A
classDef unhighlight, opacity:0.5;
```

### Merges

Change C is the result of Change A and Change B.

```mermaid
graph TB
G["Change G"]:::unhighlight --> F["Change D"]
F["Change D"]
F --> B["Change B"]
F --> C["Change C"]
B --> A["Change A"]
C --> A:::unhighlight
classDef unhighlight, opacity:0.5;
```

### History

Change G is the result of Changes D, B, C, and A.

```mermaid
graph TB
G["Change G"] --> F["Change D"]
F["Change D"]
F --> B["Change B"]
F --> C["Change C"]
B --> A["Change A"]
C --> A
```

## FAQ

### Why not call it change history?

The term "history" implies a linear sequence of changes which is incorrect. A lix change graph visualizes the relationships between changes, which includes the history but also includes other relationships such as dependencies and merges.

0 comments on commit 7b44e2e

Please sign in to comment.