Skip to content

Commit 8743312

Browse files
author
Andrew Elder
committed
add development sequence diagram
1 parent 9248045 commit 8743312

File tree

3 files changed

+71
-1
lines changed

3 files changed

+71
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,15 @@ Source documentation
247247
A standard tool, Doxygen, is used for generating documentation from the AVDECC Controller Lib source code.
248248
A link to the online version of the AVDECC Controller Lib documentation can be found at:
249249
http://www.audioscience.com/internet/download/sdk/avdecclib_usermanual_html/html/index.html
250-
250+
251+
Development Conventions
252+
=======================
253+
254+
Developers should add new features to the *staging* git branch. Periodically the *staging* git branch
255+
will be merged to the *master* branch.
256+
257+
![](git_dev_seq_uml.png)
258+
251259

252260
Roadmap
253261
=======

git_dev_seq_uml.png

68.8 KB
Loading

git_dev_seq_uml.txt

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
@startuml
2+
3+
title Git branch conventions in avdecc-lib\ndevelopment sequence
4+
5+
box "DeveloperX's\nenvironment" #LightBlue
6+
actor DeveloperX
7+
participant "branch\nin forked local\nDeveloperX's git repo" as LX
8+
end box
9+
10+
box "DeveloperY's\nenvironment" #LightYellow
11+
actor DeveloperY
12+
participant "branch\nin forked local\nDeveloperY's git repo" as LY
13+
end box
14+
15+
16+
box "upstream git" #LightBlue
17+
participant "<b>staging</b> branch\nin upstream repo" as S
18+
participant "<b>master</b> branch\nin upstream repo" as M
19+
end box
20+
actor Manager
21+
22+
note over DeveloperX
23+
In this example DeveloperX is
24+
working on a new feature
25+
end note
26+
27+
DeveloperX -> LX: commits changes to forked git repo
28+
LX -> LX: many updates
29+
30+
DeveloperX -> LX: completed a new feature
31+
LX -> S : git pull request
32+
S -> Manager : emailed pull request
33+
Manager -> S: do merge to staging
34+
S -> S : git merge
35+
36+
Manager --> DeveloperX: email request to test staging
37+
Manager --> DeveloperY: email request to test staging
38+
39+
note over DeveloperY
40+
DeveloperY is taking on the role
41+
of tester in this example
42+
end note
43+
44+
45+
loop until staging test signoff
46+
S -> DeveloperY: pulls staging branch for testing
47+
S -> LY: git pull
48+
DeveloperY -> LY: commits bugfixes to forked git repo
49+
LY -> S : git pull request
50+
S -> Manager : emailed pull request
51+
Manager -> S: do merge to staging
52+
S -> S : git merge
53+
end
54+
55+
==Signoffs for staging tests collected from all parties==
56+
57+
Manager -> S: do merge
58+
S -> M: staging merged to master branch
59+
60+
@enduml
61+
62+

0 commit comments

Comments
 (0)