Skip to content

Commit

Permalink
Document git workflow in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ulrikandersen committed Sep 6, 2024
1 parent d34c607 commit 6acca70
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,23 @@ Clone the repository and consult the articles on [running Shape Docs locally](ht
git clone [email protected]:shapehq/shape-docs.git
```

## 🔀 Git Workflow

Two long-lived branches exist

* **main** (stable/release - deploy to a **production** environment)
* **develop** (integration - deploy to a **staging** environment)

**Do's 👍**

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`.
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.
3. A hotfix is applied by branching out from `main`. The hotfix branch _must_ be merged into both `main` and `develop`.

**Don'ts 🙅‍♂️**

1. Never squash merge `develop` into `main` ☠️

## ❤️ The Product of a Shape Weekend

Every year we go on Shape Weekend, three days where all employees in Shape get together for a hackathon to build amazing products. In 2023, a team of Shape developers with a passion for documentation and spec-driven development built Shape Docs and we've used it daily ever since!
Expand Down

0 comments on commit 6acca70

Please sign in to comment.