Skip to content

Commit 0bb202f

Browse files
committed
Update CONTRIBUTING.md
1 parent bf68508 commit 0bb202f

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,23 @@ cargo clippy --workspace --all-targets --all-features -- -D warnings
6868
```
6969
If a full run is not practical, say what was tested and what was not.
7070

71+
## Branch workflow
72+
73+
UnixNotis uses two main branches:
74+
75+
- `dev` is the branch for active work
76+
- `master` is the stable branch
77+
78+
New work should start on `dev`.
79+
80+
If a fix lands on `master`, bring `dev` back in sync before continuing work there.
81+
82+
This repository has a GitHub Actions workflow that handles that sync automatically:
83+
84+
- a push to `master` triggers a `master -> dev` sync attempt
85+
- if the merge is clean, the workflow updates `dev`
86+
- if the sync cannot be completed cleanly, the workflow opens follow-up work instead of failing quietly
87+
7188
## Pull requests
7289

7390
Please try to keep pull requests easy to review.

0 commit comments

Comments
 (0)