Skip to content

Commit

Permalink
Add documentation files for object design, system design, and require…
Browse files Browse the repository at this point in the history
…ments analysis
  • Loading branch information
FelixTJDietrich committed May 25, 2024
1 parent f0362a3 commit 2db4126
Show file tree
Hide file tree
Showing 22 changed files with 211 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/_static/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
@import url("theme.css");

.wy-side-nav-search {
background-color: #e7d4fa;
background-color: #3b82f6;
}

.wy-body-for-nav .wy-nav-content {
Expand Down
103 changes: 95 additions & 8 deletions docs/hephaestus.uml
Original file line number Diff line number Diff line change
@@ -1,8 +1,95 @@
@startuml Hephaestus
!theme plain
skinparam style strictuml
skinparam SequenceMessageAlignment center

"Novice Developer" -> Hephaestus: Mentor me
"Novice Developer" <- Hephaestus: Yes
@enduml
@startuml
|Novice Developer|
start

:Ideate and Plan;
:Create Issue;

|Hephaestus|
:Review Issue;
while (Is the issue well-defined?) is (no)
:Provide Feedback on Issue;
|Novice Developer|
:Revise Issue;
endwhile (yes)
|Hephaestus|
:Approve Issue;

|Novice Developer|
:Start Working on Issue;
:Create Branch;

|Hephaestus|
:Monitor Development;
:Pair Programming Session;
fork
|Novice Developer|
:Implement Feature;
:Write Unit Tests;
:Commit Changes;
:Push Branch;
fork again
|Hephaestus|
:Provide Proactive Feedback;
:Guidance on Best Practices;
end fork

|CI/CD Pipeline|
:Run Automated Tests;
if (Tests Pass?) then (no)
repeat
|Hephaestus|
:Review Failed Tests;
:Provide Feedback on Code;
|Novice Developer|
:Fix Issues;
:Push Branch;
|CI/CD Pipeline|
:Run Automated Tests;
repeat while (Tests Pass?) is (no)
else (yes)
endif

|Hephaestus|
:Review Code;
if (Is the code up to standards?) then (yes)
:Approve Pull Request;
else (no)
:Provide Feedback on Code;
endif

|Novice Developer|
:Merge Pull Request;


|CI/CD Pipeline|
:Deploy to Staging;

|Novice Developer|
:Perform User Acceptance Testing;

|Hephaestus|
:Monitor UAT Feedback;
if (Feedback is Positive?) then (yes)
:Deploy to Production;
else (no)
:Provide Feedback on UAT;
|Novice Developer|
:Revise Code;
|CI/CD Pipeline|
:Deploy to Staging;
endif

|Novice Developer|
:Monitor Production;
:Gather Metrics;

|Hephaestus|
:Review Metrics;
:Provide Continuous Feedback;

|Novice Developer|
:Continuous Improvement;

stop
@enduml
14 changes: 7 additions & 7 deletions docs/images/hammer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2db4126

Please sign in to comment.