Skip to content

Commit a74946f

Browse files
authored
Update README.md
1 parent a47c35f commit a74946f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,22 @@ Clone the repository and consult the articles on [running Framna Docs locally](h
6363
git clone git@github.com:shapehq/framna-docs.git
6464
```
6565

66-
## 🔀 Git Workflow
66+
### 🔀 Git Workflow
6767

68-
Two long-lived branches exist
68+
Two following long-lived branches exist:
6969

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.
7272

7373
**Do's 👍**
7474

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`.
7878

7979
**Don'ts 🙅‍♂️**
8080

81-
1. Never squash merge `develop` into `main` ☠️
81+
- Never squash merge `develop` into `main`.
8282

8383
## ❤️ The Product of a Shape Weekend
8484

0 commit comments

Comments
 (0)