You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,22 +63,22 @@ Clone the repository and consult the articles on [running Framna Docs locally](h
63
63
git clone git@github.com:shapehq/framna-docs.git
64
64
```
65
65
66
-
## 🔀 Git Workflow
66
+
###🔀 Git Workflow
67
67
68
-
Two long-lived branches exist
68
+
Two following long-lived branches exist:
69
69
70
-
***main** (stable/release - deploy to a **production** environment)
71
-
***develop** (integration - deploy to a **staging** environment)
70
+
***main**: Stable/release branch meant for deployment to the production environment.
71
+
***develop**: Branch meant for deployment to a staging environment.
72
72
73
73
**Do's 👍**
74
74
75
-
1. Features are branched off from `develop` and merged back in using a PR when ready. Rebase or merge `develop` in to keep the feature branch up to date. Squash merge the feature branch into `develop`.
76
-
2.`develop` is merged into `main` whenever a new release is made. Only regular merge commits are allowed in this case. You do not need to "bring develop up to date" with `main` before merging.
77
-
3. A hotfix is applied by branching out from `main`. The hotfix branch _must_ be merged into both `main` and `develop`.
75
+
- Features are branched off from `develop` and merged back in using a PR when ready. Rebase or merge `develop` in to keep the feature branch up to date. Squash merge the feature branch into `develop`.
76
+
-`develop` is merged into `main` whenever a new release is made. Only regular merge commits are allowed in this case. You do not need to bring develop up to date with `main` before merging.
77
+
- A hotfix is applied by branching out from `main`. The hotfix branch _must_ be merged into both `main` and `develop`.
0 commit comments