Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add node diagrams of where different bits of data are. #21

Closed
wants to merge 1 commit into from
Closed

Add node diagrams of where different bits of data are. #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions episodes/02-branching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,20 @@ config:
merge large_feature
```

An alternative way of viewing this workflow is:

```mermaid
graph TD
main --> |switch/checkout| lfb["feature branch"]
lfb --> |push| rfb["feature branch"]
subgraph github
rfb --> |"pull request (PR)"| main
end
subgraph local["my computer"]
lfb
end
```

-----------------------------------------

### Forking
Expand All @@ -143,6 +157,26 @@ You develop your changes using this fork.
When a change is ready you open a pull request to contribute the changes
back to the original repository.

```mermaid
graph BT
subgraph local["my computer"]
lfb
end
subgraph github
subgraph "my fork"
rfb
mm["my copy of main"]
end
rfb --> |"pull request (PR)"| main
main --> |"sync"| mm
subgraph upstream
main
end
end
mm --> |switch/checkout| lfb["feature branch"]
lfb --> |push| rfb["feature branch"]
```

#### Pros

- Removes the need to give all collaborators adequate permissions
Expand Down Expand Up @@ -210,6 +244,35 @@ merged onto the `develop` and `main` branches.
merge release
```

Or, alternatively:

```mermaid
graph BT
subgraph local["my computer"]
lfb
lbfb
end
subgraph github
subgraph "my fork"
md["my copy of develop"]
rfb
rbfb
mm["my copy of main"]
end
rfb --> |"pull request (PR)"| develop
rbfb --> |"pull request (PR)"| main
develop --> |"sync"| md
main --> |"sync"| mm
subgraph upstream
develop <--> |sync| main
end
end
md --> |switch/checkout| lfb["feature branch"]
lbfb --> |push| rbfb["bugfix branch"]
lfb --> |push| rfb["feature branch"]
mm --> |switch/checkout| lbfb["bugfix branch"]
```

## Recommendations

For small projects using a Feature Branch model is normally sufficient.
Expand Down