This repository was archived by the owner on Apr 6, 2023. It is now read-only.
docs: expand contribution guide for ecosystem#5922
Merged
Conversation
✅ Deploy Preview for nuxt3-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
613b4f8 to
db123b6
Compare
Member
|
Looking at Contribution section it is really nice and good to me to add and iterate over honestly even with current state 🚀 Some small things could be improved:
|
Co-authored-by: Anthony Fu <hi@antfu.me>
db123b6 to
e5e8bd5
Compare
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Linked issue
❓ Type of change
📚 Description
This is an initial stab at a more generic contribution guide for the Nuxt ecosystem, splitting out generic contribution guidance from the more specific guidance for the nuxt/framework repository specifically.
The following flowcharts are taken from https://github.com/vitejs/vite/blob/main/CONTRIBUTING.md#issue-triaging-workflow. When we upgrade to Nuxt 3, we can create a dedicated component to render these, but I think we can simply link to rendered chart until that point. (cc: @antfu)
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)flowchart TD A{Followed issue template?} A-->|Yes| B{Is duplicate?} A-->|No| C(Close and ask to follow template) B-->|Yes| E(Close and point to duplicate) B-->|No| D{Has minimal reproduction?} D-->|Yes| F{Is actually a bug?} D-->|No| G(Label: 'needs reproduction'<br>might 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)📝 Checklist