From 5918a5cf1fee14222fcc3bbc828423f0feeb302a Mon Sep 17 00:00:00 2001
From: AN12345 <malo.leon.1@ens.etsmtl.ca>
Date: Mon, 21 Nov 2022 21:20:01 -0500
Subject: [PATCH] doc: add simple workflow diagramm

---
 doc/work_flow.puml | 15 +++++++++++++++
 doc/workflow.svg   | 25 +++++++++++++++++++++++++
 2 files changed, 40 insertions(+)
 create mode 100644 doc/work_flow.puml
 create mode 100644 doc/workflow.svg

diff --git a/doc/work_flow.puml b/doc/work_flow.puml
new file mode 100644
index 00000000..5e6e983d
--- /dev/null
+++ b/doc/work_flow.puml
@@ -0,0 +1,15 @@
+@startuml Simple Developpment Workflow
+start
+:Create an issue;
+:Create branch related to the issue;
+repeat :Commit related to the issue;
+repeat while (feature is done)
+:Update coverage;
+:Close issue via last commit;
+:Rebase from `master`;
+:Create pull request;
+:Merge branches;
+:Update version;
+:Publish package;
+stop
+@enduml
\ No newline at end of file
diff --git a/doc/workflow.svg b/doc/workflow.svg
new file mode 100644
index 00000000..c8443191
--- /dev/null
+++ b/doc/workflow.svg
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" height="688px" preserveAspectRatio="none" style="width:247px;height:688px;background:#FFFFFF;" version="1.1" viewBox="0 0 247 688" width="247px" zoomAndPan="magnify"><defs/><g><ellipse cx="119.5" cy="20" fill="#222222" rx="10" ry="10" style="stroke:#222222;stroke-width:1.0;"/><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="109" x="65" y="50"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="89" x="75" y="71.6016">Create an issue</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="217" x="11" y="104.1328"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="197" x="21" y="125.7344">Create branch related to the issue</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="179" x="30" y="158.2656"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="159" x="40" y="179.8672">Commit related to the issue</text><polygon fill="#F1F1F1" points="79.5,232.3984,159.5,232.3984,171.5,244.3984,159.5,256.3984,79.5,256.3984,67.5,244.3984,79.5,232.3984" style="stroke:#181818;stroke-width:0.5;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="80" x="79.5" y="248.5557">feature is done</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="118" x="60.5" y="276.3984"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="98" x="70.5" y="298">Update coverage</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="174" x="32.5" y="330.5313"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="154" x="42.5" y="352.1328">Close issue via last commit</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="152" x="43.5" y="384.6641"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="132" x="53.5" y="406.2656">Rebase from `master`</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="131" x="54" y="438.7969"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="111" x="64" y="460.3984">Create pull request</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="113" x="63" y="492.9297"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="93" x="73" y="514.5313">Merge branches</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="107" x="66" y="547.0625"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="87" x="76" y="568.6641">Update version</text><rect fill="#F1F1F1" height="34.1328" rx="12.5" ry="12.5" style="stroke:#181818;stroke-width:0.5;" width="114" x="62.5" y="601.1953"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="94" x="72.5" y="622.7969">Publish package</text><ellipse cx="119.5" cy="666.3281" fill="none" rx="11" ry="11" style="stroke:#222222;stroke-width:1.0;"/><ellipse cx="119.5" cy="666.3281" fill="#222222" rx="6" ry="6" style="stroke:#111111;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="30" y2="50"/><polygon fill="#181818" points="115.5,40,119.5,50,123.5,40,119.5,44" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="84.1328" y2="104.1328"/><polygon fill="#181818" points="115.5,94.1328,119.5,104.1328,123.5,94.1328,119.5,98.1328" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="192.3984" y2="232.3984"/><polygon fill="#181818" points="115.5,222.3984,119.5,232.3984,123.5,222.3984,119.5,226.3984" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="171.5" x2="221" y1="244.3984" y2="244.3984"/><polygon fill="#181818" points="217,212.3984,221,202.3984,225,212.3984,221,208.3984" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="221" x2="221" y1="175.332" y2="244.3984"/><line style="stroke:#181818;stroke-width:1.0;" x1="221" x2="209" y1="175.332" y2="175.332"/><polygon fill="#181818" points="219,171.332,209,175.332,219,179.332,215,175.332" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="138.2656" y2="158.2656"/><polygon fill="#181818" points="115.5,148.2656,119.5,158.2656,123.5,148.2656,119.5,152.2656" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="256.3984" y2="276.3984"/><polygon fill="#181818" points="115.5,266.3984,119.5,276.3984,123.5,266.3984,119.5,270.3984" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="310.5313" y2="330.5313"/><polygon fill="#181818" points="115.5,320.5313,119.5,330.5313,123.5,320.5313,119.5,324.5313" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="364.6641" y2="384.6641"/><polygon fill="#181818" points="115.5,374.6641,119.5,384.6641,123.5,374.6641,119.5,378.6641" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="418.7969" y2="438.7969"/><polygon fill="#181818" points="115.5,428.7969,119.5,438.7969,123.5,428.7969,119.5,432.7969" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="472.9297" y2="492.9297"/><polygon fill="#181818" points="115.5,482.9297,119.5,492.9297,123.5,482.9297,119.5,486.9297" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="527.0625" y2="547.0625"/><polygon fill="#181818" points="115.5,537.0625,119.5,547.0625,123.5,537.0625,119.5,541.0625" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="581.1953" y2="601.1953"/><polygon fill="#181818" points="115.5,591.1953,119.5,601.1953,123.5,591.1953,119.5,595.1953" style="stroke:#181818;stroke-width:1.0;"/><line style="stroke:#181818;stroke-width:1.0;" x1="119.5" x2="119.5" y1="635.3281" y2="655.3281"/><polygon fill="#181818" points="115.5,645.3281,119.5,655.3281,123.5,645.3281,119.5,649.3281" style="stroke:#181818;stroke-width:1.0;"/><!--MD5=[11dd8e2c471624b2c2c7e8b91f274ed9]
+@startuml Simple Developpment Workflow
+start
+:Create an issue;
+:Create branch related to the issue;
+repeat :Commit related to the issue;
+repeat while (feature is done)
+:Update coverage;
+:Close issue via last commit;
+:Rebase from `master`;
+:Create pull request;
+:Merge branches;
+:Update version;
+:Publish package;
+stop
+@enduml
+
+PlantUML version 1.2022.7(Mon Aug 22 13:01:30 EDT 2022)
+(GPL source distribution)
+Java Runtime: Java(TM) SE Runtime Environment
+JVM: Java HotSpot(TM) 64-Bit Server VM
+Default Encoding: UTF-8
+Language: fr
+Country: FR
+--></g></svg>
\ No newline at end of file