Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
feat: add mermaid flowcharts
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe committed Jul 21, 2022
1 parent be2a85e commit e5e8bd5
Showing 1 changed file with 46 additions and 3 deletions.
49 changes: 46 additions & 3 deletions docs/content/5.community/3.contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,37 @@ The Nuxt ecosystem includes many different projects and organizations. For examp

Check out the issues and discussions for the project you want to help. For example, here are [the issues board](https://github.com/nuxt/framework/issues) and [discussions](https://github.com/nuxt/framework/discussions) for Nuxt 3. Helping other users, sharing workarounds, creating reproductions, or even poking into a bug a little bit and sharing your findings makes a huge difference.

<!-- ### Creating an issue
### Creating an issue

TODO: mermaid process diagram following https://github.com/vitejs/vite/raw/main/.github/issue-workflow.png -->
```mermaid
flowchart TD
A{Followed issue template?}
A-->|Yes| B{Is duplicate?}
A-->|No| C(Close and ask to follow template)
B-->|Yes| D{Has proper reproduction?}
B-->|No| E(Close and point to duplicate)
D-->|Yes| F{Is actually a bug?}
D-->|No| G(Label: 'needs reproduction'<br>close if no update < 3 days)
F-->|Yes| H(1. Remove 'pending triage' label<br>2. Add 'bug' label<br>3. Add related package label if applicable<br>4. Add priority label)
F-->|No| I{Is the behavior intended?}
I-->|Yes| J(Explain and close<br>point to docs if needed)
I-->|No| K(Keep open for discussion<br>remove 'pending triage' label and add 'discussion')
H-->L{Does the behavior make Nuxt unusable?}
L-->|Yes| M{Does the bug affect the majority of users?}
L-->|No| N{Are there workarounds for the bug?}
M-->|Yes| P5(p5: urgent)
M-->|No| P4(p4: important)
N-->|Yes| P2(p2: has workaround)
N-->|No| P3(p3: minor bug)
```

See [rendered flowchart](https://kroki.io/mermaid/svg/eNp9k09v4jAQxe_9FHNLOLTSAr2gqisoZWFLUbXayx5NPAkuiW35T1sU9rvv2AlJtodyQOCZ-b15z0leqvfswIyD38sroM-8XqmSDpGDsNYjOKx0yRx-_9vUr6_vz3_QnmFRbyxwr0uRfSrv1Bke0odSWQQmOTB7BKcgj-AOOLqKE4sOuKzXzII2SqMBg_SD-8wJJVv24sJ-HLC1EtIFerdJy1123FVYlGXOs7I8AYO9L1ri8kL8kW7ZHssZJBKR2__Uk7u9uc-ioMhBKvCakwzcwQQ4O9lWb9XprdNvN_ALK_WGkGiUXMgCnBGswATKoBOI4xuYcw4JbTM4nTSnBkNC5I5lRxpr6kGe6ehyX2Lonjbd2ghlhDs1baN-nWBtE9y7A8IeD-yNGoECo6WQUwixddNt_jN9_KC7ETJGGz0HmT5jldkYAoWEfNRPB6Gn9AlRA92epKs2wIXNvLWUYGCYr_JonpKQRj-UtLmuib-tlwo_uajYEWHnPxx46W1IpL3UbWfneTDmC2B5jpmLfyv22iSmcvAWjR3OBjO7em4wtNL3uzJHZpSX9GAEYy3vEt9zp_dym-rbGXhToHSjvhiAL9NUT2cgKq2MY5fyrp8dp3o8gwO9Ab3eoCkyJqmezKASkragDUb_AI6_NHc).

### Send a pull request

Expand Down Expand Up @@ -71,7 +99,22 @@ If we request changes on a PR, please ignore the red text! It doesn't mean we th

If we mark a PR as 'pending', that means we likely have another task to do in reviewing the PR - it's an internal note-to-self, and not necessarily a reflection on whether the PR is a good idea or not. We will do our best to explain via a comment the reason for the pending status.

<!-- TODO: mermaid process diagram following https://github.com/vitejs/vite/raw/main/.github/pr-workflow.png -->
```mermaid
flowchart TD
A{What kind of PR is it?}
A---|Bug fix| B{Is it a 'strict fix'<br>i.e. fixes an obvious oversight<br>with no side effects?}
A---|Feature| C(* Discuss feature necessity<br>* Is this the best way to address the need?<br>* Review code quality<br>* Add feature labels<br>* Approve if you feel strongly that the feature is needed.)
A---|Documentation| D(* Review clarity and accuracy<br>* Look for opportunities to improve language)-->I
C-->E(Await input from Pooya)-->I
B---|Yes| F(* Verify the fix locally<br>* Review code quality<br>* Require test case if applicable<br>* Request changes if necessary)
B---|No| G(Discuss the potential side effects of the fix, e.g.:<br>* Could it introduce implicit behavior changes in other cases?<br>* Does it introduce too many changes?)
G-->H(Add priority labels)-->E
F-->I(Approve)-->J(Merge if approved by 2 or more team members)
```

[See rendered flowchart](https://kroki.io/mermaid/svg/eNqFk89vm1AMx-_9K3wrqZYcdpymRk3SdJ22qYqmVTuahwGrD0zfj6So7H-fHyTNehoHBH7G34-_NqWVg6nRBfi5uQC9bl4fawzwxG0BUsLDDtgDh-Wf6XQ-nw-rWEHJLwOsXu_TGSBc-uDYhBS-_Jy7a17QIr2QB2xB8j1L9CB7cp6rOqSUA4caWgHPBQGVJZng_1XZEoboaIB1dgUb9iZ6D-UUhJYMec-hT5WuQDFCzelGkJMPcMAeggAWhdO8Md4SFcspfUd7pgMYUeXniPatzk1RvElYzMn6Y7zrnMIDl9BL1BSyoB1LW1nVSX4lhdOXCpLEqFjMzu1sxMSG2oCBpR1gk50xLDolUKMKQGOiQ3PE-SbyBKU4kK4TF2LLgdVRbYybCchiW0WsaDafX9-PYmt9us1uDqhz4baLOhMnDTyI9DhljWmrxPSb_ABbJflFjst-aoJfwIpBa_v_mLWj58jabkiGG_SjPdh1lg3mls5J43mtpMquKdPs0PWzM8kPGeAuO005cXQS1C1G-25B0koeKT8ALarFp0lmLdEWMLasYymioWSRkmgopxp1_9yZQTdSi7gR2h93YiPk3xcIItBg25--W068d2rilyxtSue0aprctCrJ3dvJ3W0yOjtuTYp_zb6Tq04OpWgBeQ8fQbEaGU3EBhpqcv1DJp2Lvz5hNKI).

### Create a module

Expand Down

0 comments on commit e5e8bd5

Please sign in to comment.