diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0746ea655..6c118c93e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,23 +97,23 @@ VITE_NODE_DEPS_MODULE_DIRECTORIES=/node_modules/,/packages/ ```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: browser')\n3. Add priority and meta labels (see below)"] - real2 --> unusable{Does the\nbug make Vitest\nunusable?} - unusable --YES--> maj{Does the bug\naffect the majority\nof Vitest 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["1. Remove 'pending triage' label
2. Add related feature label if
applicable (e.g. 'feat: browser')
3. Add priority and meta labels (see below)"] + real2 --> unusable{Does the
bug make Vitest
unusable?} + unusable --YES--> maj{Does the bug
affect the majority
of Vitest users?} maj --YES--> p5[p5: urgent] maj --NO--> p4[p4: important] - unusable --NO--> workarounds{Are there\nworkarounds for\nthe bug?} - workarounds --YES--> p2[p2: edge case\nhas workaround] + unusable --NO--> workarounds{Are there
workarounds for
the bug?} + workarounds --YES--> p2[p2: edge case
has workaround] workarounds --NO--> p3[p3: minor bug] ``` @@ -121,16 +121,16 @@ flowchart TD ```mermaid flowchart TD - start{Bug fix\nor\nfeature} - start --BUG FIX--> strict_bug{"Is a 'strict fix'\ni.e. fixes an obvious\noversight with no\nside effects"} - start --FEATURE--> feature[- Discuss feature necessity\n- Is this the best way to address the need\n- Review code quality\n- Add feature labels\n- Approve if you feel strongly\nthat the feature is needed] + start{Bug fix
or
feature} + start --BUG FIX--> strict_bug{"Is a 'strict fix'
i.e. fixes an obvious
oversight with no
side effects"} + start --FEATURE--> feature[- Discuss feature necessity
- Is this the best way to address the need
- Review code quality
- Add feature labels
- Approve if you feel strongly
that the feature is needed] feature --> merge - strict_bug --YES--> strict[- Verify the fix locally\n- Review code quality\n- Require test case if applicable\n- Request changes if necessary] - strict_bug --NO--> non_strict[- Discuss the potential side\neffects of the fix, e.g.\n- Could it introduce implicit\nbehavior changes in other\ncases?\n- Does it introduce too much\nchanges?] - non_strict --> label["Add priority labels\n(see issue triaging workflow)"] + strict_bug --YES--> strict[- Verify the fix locally
- Review code quality
- Require test case if applicable
- Request changes if necessary] + 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?] + non_strict --> label["Add priority labels
(see issue triaging workflow)"] strict --> label label --> approve - approve --> merge["Merge if approved by 2 or\nmore team members\n- Use 'Squash and Merge'\n- Edit commit message to follow\nconvention\n- In commit message body, list\nrelevant issues being fixed\ne.g. 'fix #1234, fix #1235'"] + approve --> merge["Merge if approved by 2 or
more team members
- 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