Skip to content

Commit 46d94f8

Browse files
committed
Update contribution workflow diagram
1 parent 8a09b72 commit 46d94f8

File tree

1 file changed

+18
-28
lines changed

1 file changed

+18
-28
lines changed

README.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -115,34 +115,24 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
115115

116116
```mermaid
117117
flowchart TD
118-
Start(["Start"])
119-
CodingGuidelineIdea["Coding Guideline Idea"]
120-
DiscussOnZulip[/"(Optional)<br>Discuss on Zulip"/]
121-
CodingGuidelineIssue["Coding Guideline Issue"]
122-
CodingGuidelinePR["Coding Guideline <br> Pull Request"]
123-
Main[[main]]
124-
End(["End"])
125-
126-
%% new: small local hop nodes (no self-loops)
127-
IssueReview{{"2: subcommittee member<br>reviews within 14 days<br><br>contributor updates issue"}}
128-
PRReview{{"4: subcommittee members<br>review within 14 days<br><br>contributor discusses on<br>PR as needed"}}
129-
130-
Start -- contributor thinks of idea --> CodingGuidelineIdea
131-
CodingGuidelineIdea -- 0: optionally post on Zulip --> DiscussOnZulip
132-
DiscussOnZulip -- 1: contributor creates <br> coding guideline issue --> CodingGuidelineIssue
133-
134-
%% replace Issue self-loop
135-
CodingGuidelineIssue --> IssueReview --> CodingGuidelineIssue
136-
137-
CodingGuidelineIssue -- 3: subcommittee member <br> assigns label to <br> generate pull request --> CodingGuidelinePR
138-
139-
%% replace PR self-loop
140-
CodingGuidelinePR --> PRReview --> CodingGuidelinePR
141-
142-
CodingGuidelinePR -- 5: contributor applies <br> feedback to coding <br> guideline issue --> CodingGuidelineIssue
143-
CodingGuidelineIssue -- 6: subcomittee member <br> confirms changes; <br> assigns label to <br> regenerate PR --> CodingGuidelinePR
144-
CodingGuidelinePR -- 7: subcommittee member <br> approves, adds <br> to merge queue; <br> gets merged to main --> Main
145-
Main -- process complete --> End
118+
Start(["Start"]) --> Idea["Coding Guideline Idea"]
119+
Idea --> Zulip[/"(Optional)<br>0: Contributor brings <br> to discuss on Zulip"/]
120+
Zulip --> CreateIssue{{"1: Contributor creates <br> issue"}}
121+
CreateIssue --> Issue["Coding Guideline Issue"]
122+
123+
%% short local loops (no long edges)
124+
S2{{"2: Review started <br> by subcommittee <br> member in <= 14 days"}} --> Issue
125+
Issue --> S2
126+
127+
Issue --> S3{{"3: Subcommitte member <br> assigns label<br>to generate PR"}} --> PR["Coding Guideline<br>Pull Request"]
128+
129+
S4{{"4: PR review started <br> by subcommittee member <br> in <= 14 days"}} --> PR
130+
PR --> S4
131+
132+
PR --> S5{{"5: Contributor applies <br> feedback to issue"}} --> Issue
133+
Issue --> S6{{"6: Subcommittee member <br> confirms changes;<br> regenerates PR"}} --> PR
134+
PR --> S7{{"7: Subcommittee member <br> approves & queues;<br>merges to main"}} --> Main[[main]]
135+
Main --> End(["End"])
146136
```
147137

148138
### 0. Have an idea for a coding guideline? Want to discuss it?

0 commit comments

Comments
 (0)