Skip to content

docs(contributing): document dev branch workflow #3589

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

Open
jstvz wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs(contributing): document dev branch workflow #3589

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
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,24 @@ command:

After running, you can view the Storybook at <http://localhost:6006/> in your
browser.

## Branching workflow

MetaDeploy uses two long-lived branches:

- `main` — released code. Reviewed, gated by required CI checks. Auto-deploys to staging; staging is manually promoted to production.
- `dev` — integration branch for in-flight work. Gated by required CI checks only; no required review. Deploys to a persistent dev-app at `https://metadeploy-dev.herokuapp.com/`.

### Where to send PRs

- Long-lived feature work: PR against `dev`. The author self-merges (squash) once CI is green.
- Hotfixes against released code: PR against `main`. Existing review requirement applies.
- Promotions of `dev` to `main` happen on-demand when production needs the change. The author opens a `dev → main` PR for required review at that point.

### Branch-naming convention

Topic branches use descriptive names that describe the work: `feature/<work>`, `fix/<bug>`, `chore/<housekeeping>`. Do not encode plan structure or phase numbering in branch names.

### Stability of `dev`

`dev` carries unreviewed code that has only passed CI. It is work-in-progress, not a release artifact. Downstream forks should NOT pin to `dev` or expect stability there. Pull from `main` (or a tagged release) for downstream consumption.
Loading