chore: add contribution docs to the repository (nuxt#435)

Co-authored-by: Sébastien Chopin <seb@nuxtjs.com> Co-authored-by: Daniel Roe <daniel@roe.dev>
tiger-yash · Sep 10, 2021 · de17f13 · de17f13
1 parent a1462ff
commit de17f13
Show file tree

Hide file tree

Showing 9 changed files with 192 additions and 32 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report-nuxt2.md b/.github/ISSUE_TEMPLATE/bug-report-nuxt2.md
@@ -0,0 +1,41 @@
+---
+name: "🐞 Bug report"
+about: Create a report to help us improve Nuxt Bridge
+title: ''
+labels: bug, bridge
+assignees: ''
+---
+
+<!--
+Please carefully read the contribution docs before creating a bug report
+ 👉 https://v3.nuxtjs.org/community/reporting-bugs
+
+Please use the codesandbox template below to create a minimal reproduction
+ 👉 https://codesandbox.io/s/github/nuxt/starter/tree/bridge-sandbox
+
+If you're unsure about the issue, please open a github discussion first
+ 👉 https://github.com/nuxt/framework/discussions/categories/issues
+-->
+
+**🪟 Environment**
+
+<!-- You can use `npx nuxi info` to fill this section -->
+
+**🖊️ Describe the bug and expected behavior**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**📝 Steps to reproduce**
+
+<!--
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+-->
+
+** ➕ Additional context**
+
+<!-- If applicable, add any other context about the problem here. -->
+<!-- If applicable, add screenshots to help explain your problem. -->
diff --git a/.github/ISSUE_TEMPLATE/bug-report-nuxt3.md b/.github/ISSUE_TEMPLATE/bug-report-nuxt3.md
@@ -0,0 +1,41 @@
+---
+name: "🐞 Bug report"
+about: Create a report to help us improve Nuxt 3
+title: ''
+labels: bug, nuxt3
+assignees: ''
+---
+
+<!--
+Please carefully read the contribution docs before creating a bug report
+ 👉 https://v3.nuxtjs.org/community/reporting-bugs
+
+Please use the codesandbox template below to create a minimal reproduction
+ 👉 https://codesandbox.io/s/github/nuxt/starter/tree/v3-sandbox
+
+If you're unsure about the issue, please open a github discussion first
+ 👉 https://github.com/nuxt/framework/discussions/categories/issues
+-->
+
+**🪟 Environment**
+
+<!-- You can use `npx nuxi info` to fill this section -->
+
+**🖊️ Describe the bug and expected behavior**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**📝 Steps to reproduce**
+
+<!--
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+-->
+
+** ➕ Additional context**
+
+<!-- If applicable, add any other context about the problem here. -->
+<!-- If applicable, add screenshots to help explain your problem. -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,7 @@
+contact_links:
+  - name: 📚 Documentation
+    url: https://v3.nuxtjs.org/
+    about: Check documentation for usage
+  - name: 💬 Discussions
+    url: https://github.com/nuxt/framework/discussions
+    about: Use discussions if you have an idea for improvement and asking questions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,34 @@
+<!---
+Provide a general summary of your changes in the title above.
+Example: fix(nitro): fix assets dir handling
+-->
+
+## 🔗 Linked issue
+
+<!-- ❗ Please ensure there is an open issue  -->
+...
+
+## 🖊️ Types of changes
+
+<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Documentation (updates to the documentation or readme)
+- [ ] Bug fix (a non-breaking change which fixes an issue)
+- [ ] Enhancenment (improving an exisiting functionality like performance)
+- [ ] New feature (a non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## 📚 Description
+
+<!-- Describe your changes in detail -->
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it resolves an open issue, please link to the issue here. For example "Resolves: #1337" -->
+
+## 📝 Checklist
+
+<!-- Put an `x` in all the boxes that apply. -->
+<!-- If your change requires a documentation PR, please link it appropriately -->
+<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] I have linked an issue or discussion.
+- [ ] I have updated the documentation accordingly.
+
diff --git a/.github/logo.svg b/.github/logo.svg
diff --git a/README.md b/README.md
@@ -1,38 +1,60 @@
 <h1>
-  <a href="https://nuxtjs.org">
-    <img alt="NuxtJS" src="https://user-images.githubusercontent.com/904724/127682204-effdc7c6-6b46-4bf3-bd0e-a457f7530209.png" height="60">
-  </a>
+  <img src="./.github/logo.svg" >
  </h1>
 
-Welcome to Nuxt3 repository ✨
-
-## 👀 Private beta
-
-We are currently in private beta in order to stabilize the framework before onboarding the whole community.
-
-Our focus is currently on new projects made with Nuxt3 (not transitioning from Nuxt2 at the moment) as well as migrating modules to Nuxt3.
+ <p>
+  <a href="https://github.com/nuxt/framework/actions?query=branch%3Amain+event%3Apush"><img src="https://github.com/nuxt/framework/workflows/ci/badge.svg?branch=main&event=push" alt="CI Status"></a>
+  <a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/dm/nuxt3" alt="Downloads"></a>
+  <a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/v/nuxt3" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/nuxt3"><img src="https://badgen.net/npm/license/nuxt3" alt="License"></a>
+  <a href="https://discord.nuxtjs.org/"><img src="https://badgen.net/badge/Discord/join-us/7289DA" alt="Discord"></a>
+ </p>
 
-Please take a look at the [main discussion](https://github.com/nuxt/framework/discussions/434) for further information.
-
-## 📖 Documentation
-
-You can read the documentation online [here](https://v3.nuxtjs.org/).
-
-## 🐞 Reporting bugs
+Welcome to Nuxt3 repository ✨
 
-In order to report a bug, please use the [New issue](https://github.com/nuxt/framework/issues/new) form and follow the template to provide a bug reproduction.
+<table>
+<tbody>
+<tr>
+  <td>
+    <h2>📖 Documentation</h2>
+    <p>
+      Read <a href="https://v3.nuxtjs.org">Online Docs</a> here!
+    </p>
+  </td>
+  <td>
+    <h2>🐞 Reporting bugs</h2>
+    <p>
+      Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Reporting Bugs</a> page </p>
+  </td>
+</tr>
+<tr>
+  <td>
+    <h2>💡 Suggestions </h2>
+    <p>
+      Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Contribution</a> page
+    </p>
+  </td>
+  <td>
+    <h2>❔ Questions</h2>
+    <p>
+      Check out <a href="https://v3.nuxtjs.org/community/reporting-bugs">Getting Help</a> page
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
 
-## 💡 Suggestions
 
-Please create a [discussion](https://github.com/nuxt/framework/discussions/new) for improvements or feature requests.
+## 👀 Private beta
 
-## ❔ Questions
+We are currently in private beta in order to stabilize the framework before opening to the whole community.
 
-Please create a [discussion](https://github.com/nuxt/framework/discussions/new) for questions about Nuxt3 usage.
+Please take a look at the [beta discussion](https://github.com/nuxt/framework/discussions/434) for further information.
 
 ## 💻 Development
 
 - Clone repository
+- Ensure you have the latest LTS version of Node.js installed
 - Install dependencies with `yarn install`
-- Run `yarn stub`
+- Run `yarn stub` to activate passive development
 - Open playground with `yarn play`
diff --git a/docs/content/99.community/3.contribution.md b/docs/content/99.community/3.contribution.md
@@ -4,12 +4,6 @@ Nuxt is a community project - and so we love contributions of all kinds! ❤️
 
 There are a range of different ways you might be able to contribute to the Nuxt ecosystem.
 
-## Create a module
-
-If you've built something with Nuxt that's cool, why not [extract it into a module](/modules/kit), so it can be shared with others? We have [many awesome modules already](https://modules.nuxtjs.org/) but there's always room for more.
-
-If you need help while building it, feel free to [check in with us](/community/getting-help).
-
 ## Improve our documentation
 
 Documentation is one of the most important parts of Nuxt. We aim to be an intuitive framework - and a big part of that is making sure that both the developer experience and the docs are perfect. 👌
@@ -62,4 +56,10 @@ If you are adding a new feature, or refactoring or changing the behavior of Nuxt
 
 When submitting your PR, there is a simple template that you have to fill out. Please tick all appropriate "answers" in the checklists.
 
-Particularly, make sure your PR title adheres to [Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/), and do link the related issue (feature request or bug report) in the issue description. 
+<!-- ## Create a module
+
+If you've built something with Nuxt that's cool, why not [extract it into a module](/modules/kit), so it can be shared with others? We have [many awesome modules already](https://modules.nuxtjs.org/) but there's always room for more.
+
+If you need help while building it, feel free to [check in with us](/community/getting-help). -->
+
+Particularly, make sure your PR title adheres to [Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/), and do link the related issue (feature request or bug report) in the issue description.
diff --git a/docs/content/99.community/4.involvement.md b/docs/content/99.community/4.involvement.md
diff --git a/docs/content/99.community/5.governance.md b/docs/content/99.community/5.governance.md