Skip to content

Commit 23f2155

Browse files
committed
docs(18-workflows): Update workflows chapter.
1 parent 55c3aa8 commit 23f2155

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

docs/18-workflows.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The video by Nick Chapsas "Getting started with branching workflows, Git Flow and GitHub Flow" provides a summary of these two workflows.
44

5-
[Getting started with branching workflows, Git Flow and GitHub Flow (youtube.com)](https://www.youtube.com/watch?v=gW6dFpTMk8s)
5+
<iframe width="560" height="315" src="https://www.youtube.com/embed/gW6dFpTMk8s?si=H6Hhn5CDRE5BLNSD" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
66

77
## Git Flow Workflow
88

@@ -14,14 +14,18 @@ Here's how it works:
1414

1515
1. **Main Branches**: There are two main branches:
1616
- `main`(or `master`): This is the branch that contains the production-ready code.
17+
1718
- `develop`: This is the branch where all the new features and bug fixes are integrated before being merged into
1819
the`main`branch.
20+
1921
2. **Supporting Branches**: There are also supporting branches for specific tasks:
2022
- `feature`branches: These branches are used to develop new features. When a feature is complete, it is merged back
2123
into the`develop`branch.
24+
2225
- `release`branches: When the`develop`branch is stable and ready for a release, a`release`branch is created from it.
2326
This is where any last-minute bug fixes or documentation updates are made before the release is merged into
2427
the`main`branch and tagged with a version number.
28+
2529
- `hotfix`branches: These branches are used to quickly fix critical issues in the production code (`master`branch).
2630
When the fix is complete, it is merged back into both the`main`and`develop`branches.
2731

@@ -36,24 +40,33 @@ It's designed to work well with GitHub's features and allows for more frequent d
3640
Here's how it works:
3741

3842
1. **Main Branch**: There is only one main branch, typically called`main`or `master`.
43+
3944
2. **Feature Branches**: Whenever you want to work on a new feature or bug fix, you create a new branch from the `main`
4045
branch.
46+
4147
3. **Pull Requests**: When you're ready to merge your changes back into the `main` branch, you create a Pull Request. This
4248
allows others to review your code and provide feedback before merging.
49+
4350
4. **Code Reviews**: The Pull Request triggers a code review process, where team members can discuss the changes,
4451
suggest improvements, or request additional changes.
52+
4553
5. **Merge and Deploy**: Once the code has been reviewed and approved, the feature branch is merged into the `main`
4654
branch. This merged code can then be deployed to production.
4755

4856
GitHub Flow encourages frequent, small updates to the codebase, making it easier to manage and integrate changes.
4957

50-
## Further Reading and Tutorials
5158

52-
Select one or two to review and make notes about.
59+
# References
5360

54-
Feel free to feedback as to what you think about the selected items.
61+
The references show details of any articles, videos and other items that were used in this chapter, plus other, possibly useful items.
62+
63+
Chapsas, N. (2021). _Getting started with branching workflows, Git Flow and GitHub Flow_. [online] www.youtube.com. Available at: https://www.youtube.com/watch?v=gW6dFpTMk8s [Accessed 15 Mar. 2024].
64+
65+
Git Dailies (n.d.). _Guide to Git Flow_. [online] GitDailies: Software Engineering Metrics Made Easy. Available at: https://gitdailies.com/articles/git-flow-guide/ [Accessed 15 Mar. 2024].
66+
67+
68+
Other links
5569

56-
- [Guide to Git Flow (gitdailies.com)](https://gitdailies.com/articles/git-flow-guide/)
5770
- [Git Workflow | Atlassian Git Tutorial](https://www.atlassian.com/git/tutorials/comparing-workflows)
5871
- [How To Use Git Flow Effectively (marketsplash.com)](https://marketsplash.com/tutorials/git/git-flow/)
5972
- [Git Flow | Developer Experience Knowledge Base](https://developerexperience.io/articles/git-flow)
@@ -68,5 +81,9 @@ Feel free to feedback as to what you think about the selected items.
6881
- [Understanding the GitHub Flow | GitHub Guides (gitbooks.io)](https://roachhd.gitbooks.io/github-guides/content/flow/flow.html)
6982
- [Git Flow vs GitHub Flow | Alex Hyett](https://www.alexhyett.com/git-flow-github-flow/)
7083
- [Git Flow vs GitHub Flow: What You Need to Know (youtube.com)](https://www.youtube.com/watch?v=hG_P6IRAjNQ&feature=youtu.be)
71-
-
72-
-
84+
- ...
85+
86+
87+
88+
89+
[Stashing](17-stashing.md) | [...](.)

0 commit comments

Comments
 (0)