Skip to content

Commit

Permalink
docs: fix rendering issues in mermaid JS diagrams (#18731)
Browse files Browse the repository at this point in the history
  • Loading branch information
kitsune7 authored Nov 21, 2024
1 parent 27d70b5 commit c45576a
Showing 1 changed file with 60 additions and 22 deletions.
82 changes: 60 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,42 +207,80 @@ You can set the `--debug` option to turn on debugging logs (e.g. `vite --debug r

```mermaid
flowchart TD
start{Followed issue\ntemplate?}
start --NO--> close1[Close and ask to\nfollow template]
start{Followed issue
template?}
start --NO--> close1["Close and ask to
follow template"]
start --YES--> dupe{Is duplicate?}
dupe --YES--> close2[Close and point\nto duplicate]
dupe --NO--> repro{Has proper\nreproduction?}
repro --NO--> close3[Label: 'needs reproduction'\nbot will auto close if no update\nhas been made in 3 days]
dupe --YES--> close2[Close and point
to duplicate]
dupe --NO--> repro{Has proper
reproduction?}
repro --NO--> close3[Label: 'needs reproduction'
bot will auto close if no update
has been made in 3 days]
repro --YES--> real{Is actually a bug?}
real --NO--> intended{Is the intended\nbehaviour?}
intended --YES--> explain[Explain and close\npoint to docs if needed]
intended --NO--> open[Keep open for discussion\nRemove 'pending triage' label]
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)"]
real2 --> unusable{Does the\nbug make Vite\nunusable?}
unusable --YES--> maj{Does the bug\naffect the majority\nof Vite users?}
real --NO--> intended{Is the intended
behaviour?}
intended --YES--> explain[Explain and close
point to docs if needed]
intended --NO--> open[Keep open for discussion
Remove 'pending triage' label]
real --YES--> real2["① Remove 'pending triage' label
② Add related feature label if applicable
(e.g. 'feat: ssr')
③ Add priority and meta labels (see below)"]
real2 --> unusable{Does the
bug make Vite
unusable?}
unusable --YES--> maj{Does the bug
affect the majority
of Vite users?}
maj --YES--> p5[p5: urgent]
maj --NO--> p4[p4: important]
unusable --NO--> workarounds{Are there\nworkarounds for\nthe bug?}
unusable --NO--> workarounds{Are there
workarounds for
the bug?}
workarounds --NO--> p3[p3: minor bug]
workarounds --YES--> p2[p2: edge case\nhas workaround]
workarounds --YES--> p2[p2: edge case
has workaround]
```

### Pull Request Review Workflow

```mermaid
flowchart TD
start{Bug fix\nor\nfeature}
start --BUG FIX--> strict_bug{"Is this a 'strict fix'?\ni.e. fixes an obvious\noversight with no\nside effects"}
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]
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]
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]
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]
start{Bug fix
or
feature}
start --BUG FIX--> strict_bug{"Is this a 'strict fix'?
i.e. fixes an obvious oversight with no side effects"}
start --FEATURE--> feature[• Discuss feature necessity
• Is there a better way to address the need?
• Review code quality
• Add labels
• Add to milestone
• Add to Team Board]
feature -.-> approve_non_strict[• Run vite-ecosystem-ci if needed
• Approve if you feel strongly that the PR is needed and add to milestone]
strict_bug --YES--> strict[• Verify the fix locally
• Review code quality
• Require test case if applicable
• Request changes if necessary
• Add labels]
strict_bug --NO--> non_strict[Discuss the potential side effects of the fix, e.g.
• Could it introduce implicit behavior changes in other cases?
• Does it introduce too much changes?
• Add labels
• Add to Team Board]
non_strict -.-> approve_non_strict
strict --> approve_strict[Approve if ready to be merged]
approve_strict --> merge_strict[Merge if approved by 2 or\nmore team members]
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]
approve_strict --> merge_strict[Merge if approved by 2 or more team members]
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]
merge_non_strict -.-> merge_extra
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'"]
merge_strict --> merge_extra["• Use 'Squash and Merge'
• Edit commit message to follow convention
• In commit message body, list relevant issues being fixed e.g. 'fix #1234, fix #1235'"]
```

## Notes on Dependencies
Expand Down

0 comments on commit c45576a

Please sign in to comment.