Skip to content

Commit c45576a

Browse files
authored
docs: fix rendering issues in mermaid JS diagrams (#18731)
1 parent 27d70b5 commit c45576a

File tree

1 file changed

+60
-22
lines changed

1 file changed

+60
-22
lines changed

CONTRIBUTING.md

Lines changed: 60 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -207,42 +207,80 @@ You can set the `--debug` option to turn on debugging logs (e.g. `vite --debug r
207207

208208
```mermaid
209209
flowchart TD
210-
start{Followed issue\ntemplate?}
211-
start --NO--> close1[Close and ask to\nfollow template]
210+
start{Followed issue
211+
template?}
212+
start --NO--> close1["Close and ask to
213+
follow template"]
212214
start --YES--> dupe{Is duplicate?}
213-
dupe --YES--> close2[Close and point\nto duplicate]
214-
dupe --NO--> repro{Has proper\nreproduction?}
215-
repro --NO--> close3[Label: 'needs reproduction'\nbot will auto close if no update\nhas been made in 3 days]
215+
dupe --YES--> close2[Close and point
216+
to duplicate]
217+
dupe --NO--> repro{Has proper
218+
reproduction?}
219+
repro --NO--> close3[Label: 'needs reproduction'
220+
bot will auto close if no update
221+
has been made in 3 days]
216222
repro --YES--> real{Is actually a bug?}
217-
real --NO--> intended{Is the intended\nbehaviour?}
218-
intended --YES--> explain[Explain and close\npoint to docs if needed]
219-
intended --NO--> open[Keep open for discussion\nRemove 'pending triage' label]
220-
real --YES--> real2["1. Remove 'pending triage' label\n2. Add related feature label if\napplicable (e.g. 'feat: ssr')\n3. Add priority and meta labels (see below)"]
221-
real2 --> unusable{Does the\nbug make Vite\nunusable?}
222-
unusable --YES--> maj{Does the bug\naffect the majority\nof Vite users?}
223+
real --NO--> intended{Is the intended
224+
behaviour?}
225+
intended --YES--> explain[Explain and close
226+
point to docs if needed]
227+
intended --NO--> open[Keep open for discussion
228+
Remove 'pending triage' label]
229+
real --YES--> real2["① Remove 'pending triage' label
230+
② Add related feature label if applicable
231+
(e.g. 'feat: ssr')
232+
③ Add priority and meta labels (see below)"]
233+
real2 --> unusable{Does the
234+
bug make Vite
235+
unusable?}
236+
unusable --YES--> maj{Does the bug
237+
affect the majority
238+
of Vite users?}
223239
maj --YES--> p5[p5: urgent]
224240
maj --NO--> p4[p4: important]
225-
unusable --NO--> workarounds{Are there\nworkarounds for\nthe bug?}
241+
unusable --NO--> workarounds{Are there
242+
workarounds for
243+
the bug?}
226244
workarounds --NO--> p3[p3: minor bug]
227-
workarounds --YES--> p2[p2: edge case\nhas workaround]
245+
workarounds --YES--> p2[p2: edge case
246+
has workaround]
228247
```
229248

230249
### Pull Request Review Workflow
231250

232251
```mermaid
233252
flowchart TD
234-
start{Bug fix\nor\nfeature}
235-
start --BUG FIX--> strict_bug{"Is this a 'strict fix'?\ni.e. fixes an obvious\noversight with no\nside effects"}
236-
start --FEATURE--> feature[- Discuss feature necessity\n- Is there a better way\nto address the need?\n- Review code quality\n- Add labels\n- Add to milestone\n- Add to Team Board]
237-
feature -.-> approve_non_strict[- Run vite-ecosystem-ci if needed\n- Approve if you feel strongly\nthat the PR is needed\nand add to milestone]
238-
strict_bug --YES--> strict[- Verify the fix locally\n- Review code quality\n- Require test case if applicable\n- Request changes if necessary\n- Add labels]
239-
strict_bug --NO--> non_strict[Discuss the potential side\neffects of the fix, e.g.\n- Could it introduce implicit\nbehavior changes in other cases?\n- Does it introduce too much changes?\n- Add labels\n- Add to Team Board]
253+
start{Bug fix
254+
or
255+
feature}
256+
start --BUG FIX--> strict_bug{"Is this a 'strict fix'?
257+
i.e. fixes an obvious oversight with no side effects"}
258+
start --FEATURE--> feature[• Discuss feature necessity
259+
• Is there a better way to address the need?
260+
• Review code quality
261+
• Add labels
262+
• Add to milestone
263+
• Add to Team Board]
264+
feature -.-> approve_non_strict[• Run vite-ecosystem-ci if needed
265+
• Approve if you feel strongly that the PR is needed and add to milestone]
266+
strict_bug --YES--> strict[• Verify the fix locally
267+
• Review code quality
268+
• Require test case if applicable
269+
• Request changes if necessary
270+
• Add labels]
271+
strict_bug --NO--> non_strict[Discuss the potential side effects of the fix, e.g.
272+
• Could it introduce implicit behavior changes in other cases?
273+
• Does it introduce too much changes?
274+
• Add labels
275+
• Add to Team Board]
240276
non_strict -.-> approve_non_strict
241277
strict --> approve_strict[Approve if ready to be merged]
242-
approve_strict --> merge_strict[Merge if approved by 2 or\nmore team members]
243-
approve_non_strict -.-> merge_non_strict[Merge if approved by 2 or\nmore team members\nand the PR has been discussed\n in a team meeting]
278+
approve_strict --> merge_strict[Merge if approved by 2 or more team members]
279+
approve_non_strict -.-> merge_non_strict[Merge if approved by 2 or more team members and the PR has been discussed in a team meeting]
244280
merge_non_strict -.-> merge_extra
245-
merge_strict --> merge_extra["- Use 'Squash and Merge'\n- Edit commit message to follow convention\n- In commit message body, list\nrelevant issues being fixed\ne.g. 'fix #1234, fix #1235'"]
281+
merge_strict --> merge_extra["• Use 'Squash and Merge'
282+
• Edit commit message to follow convention
283+
• In commit message body, list relevant issues being fixed e.g. 'fix #1234, fix #1235'"]
246284
```
247285

248286
## Notes on Dependencies

0 commit comments

Comments
 (0)