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

docs: expand contribution guide for ecosystem #5922

Merged
merged 10 commits into from
Jul 22, 2022
Merged

docs: expand contribution guide for ecosystem #5922

merged 10 commits into from
Jul 22, 2022

Conversation

danielroe
Copy link
Member

@danielroe danielroe commented Jul 15, 2022

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to 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)
Loading
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)
Loading

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@netlify
Copy link

netlify bot commented Jul 15, 2022

βœ… Deploy Preview for nuxt3-docs ready!

Name Link
πŸ”¨ Latest commit d7bcdc1
πŸ” Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/62da5e201e90020008c9ce96
😎 Deploy Preview https://deploy-preview-5922--nuxt3-docs.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pi0
Copy link
Member

pi0 commented Jul 15, 2022

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:

  • Send a pull request: There should be an issue that describes and confirms it by a framework team member This saves lots of time and dangling PRs that are halfway to solution.
  • Feature requests are currently via discussions. I'm okay if we add issue template in same PR for feature requests.
  • It could be better explained that PRs should ideally do one thing and being splitted.
  • pending is usually meaning for another task. Sometimes it is because a PR opened too early and decide how to move it forward (or close) is pending. I think we can make it clear PRs with pending label, receive and explanation comment why they are pending.
  • For RFC process (I love state labels BTW!) we might add rfc: ready to implement too when an issue(s) is created and assigned to implement.
  • Package manager: "For libraries" might go to the last. Seems confusing to me being first or even mentioned because we are mainly talking about nuxt here.
  • Formatting: We can link to prettier issue that we plan to enable soon

@danielroe danielroe marked this pull request as ready for review July 21, 2022 13:56
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this.

@pi0 pi0 merged commit 82dab41 into main Jul 22, 2022
@pi0 pi0 deleted the docs/contribution branch July 22, 2022 08:25
@pi0 pi0 mentioned this pull request Aug 5, 2022
@danielroe danielroe added the 3.x label Jan 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants