Skip to content

Commit 602df5b

Browse files
authored
Merge pull request #223 from yscraft/docs/contributing-fork-pr-flow
docs: add fork PR flow diagram to CONTRIBUTING.md
2 parents 3b86546 + a8aa8d8 commit 602df5b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,44 @@ docs: add examples for CREATE WORKFLOW (closes #789)
334334
refactor: simplify executor dispatch logic
335335
```
336336

337+
### Fork PR Flow
338+
339+
If you're contributing from a fork, this is the full cycle:
340+
341+
```
342+
jsmith/mxcli (fork) mendixlabs/mxcli (origin)
343+
───────────────────── ─────────────────────────
344+
345+
┌─────────────────────┐
346+
│ origin/main │
347+
└──────────┬──────────┘
348+
349+
git fetch origin │
350+
┌─────────────────────┐ ◀────────────────────┘
351+
│ local main │
352+
│ git merge origin/ │
353+
│ main │
354+
└──────────┬──────────┘
355+
356+
┌──────────▼──────────┐
357+
│ feature branch │
358+
└──────────┬──────────┘
359+
360+
┌──────────▼──────────┐
361+
│ git push fork │ ← push to jsmith/mxcli
362+
└──────────┬──────────┘
363+
364+
┌──────────▼──────────┐ ┌─────────────────────┐
365+
│ open PR on GH │ ────────▶ │ mendixlabs/main │
366+
│ (fork → origin) │ └──────────┬──────────┘
367+
└─────────────────────┘ │
368+
┌──────────▼──────────┐
369+
│ review + merge │
370+
└──────────┬──────────┘
371+
372+
git fetch origin (repeat ↑)
373+
```
374+
337375
### Scope
338376

339377
- Each commit does **one thing** (feature, bugfix, or refactor)

0 commit comments

Comments
 (0)