Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: add 2nd half of flowchart #26

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 30 additions & 20 deletions site/content/flowcharts/lonecoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,37 @@ part of your development process.

{{< mermaid >}}
%% lonecoder mermaid
graph TD;
Link(Links to more info)
A([Start]) --> B(Meet initial requirements)
%%YouAreHere(You are here)
B --> C(Find a reviewer)
C --> D(Meet and agree on objectives)
D --> E(Explain scientific context)
E --> F(Explain code structure)
F --> G{Is code large?}
G -- No --> H[Select up to 400 lines to work on]
G -- Yes --> I[Split into smaller sections and agree on a series of reviews]
flowchart LR
H-->REVIEWLOOP
I-->REVIEWLOOP
subgraph MAIN
direction TD;
Link(Links to more info)
A([Start]) --> B(Meet initial requirements)
%%YouAreHere(You are here)
B --> C(Find a reviewer)
C --> D(Meet and agree on objectives)
D --> E(Explain scientific context)
E --> F(Explain code structure)
F --> G{Is code large?}
G -- No --> H[Select up to 400 lines to work on]
G -- Yes --> I[Split into smaller sections and agree on a series of reviews]

click C "https://researchcodereviewcommunity.github.io/dev-review/recipes/find_a_reviewer/" "Find a reviewer"
click D "https://researchcodereviewcommunity.github.io/dev-review/recipes/meet_and_agree_on_objectives/" "Meet and agree on objectives"
click F "https://researchcodereviewcommunity.github.io/dev-review/recipes/explain_code_structure/" "Explain code structure"

classDef default fill:#8EB6DE,stroke:#162D4D,stroke-width:2px,color:#162D4D;
classDef linkedBox fill:#FABB00,stroke:#000,stroke-width:2px,color:#000;
classDef youAreHereBox fill:#FA3800,stroke:#000,stroke-width:2px,color:#000;
class Link,C,D,F linkedBox
class YouAreHere youAreHereBox
end
subgraph REVIEWLOOP
direction TD
A2(Review) --> B2(Keep Reviewing)
end

click C "https://researchcodereviewcommunity.github.io/dev-review/recipes/find_a_reviewer/" "Find a reviewer"
click D "https://researchcodereviewcommunity.github.io/dev-review/recipes/meet_and_agree_on_objectives/" "Meet and agree on objectives"
click F "https://researchcodereviewcommunity.github.io/dev-review/recipes/explain_code_structure/" "Explain code structure"

classDef default fill:#8EB6DE,stroke:#162D4D,stroke-width:2px,color:#162D4D;
classDef linkedBox fill:#FABB00,stroke:#000,stroke-width:2px,color:#000;
classDef youAreHereBox fill:#FA3800,stroke:#000,stroke-width:2px,color:#000;
class Link,C,D,F linkedBox
class YouAreHere youAreHereBox
{{< /mermaid >}}

To read about this workflow in detail, please see
Expand Down