mirror of https://github.com/nuxt/nuxt.git
chore: add contribution docs to the repository (#435)
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com> Co-authored-by: Daniel Roe <daniel@roe.dev>
This commit is contained in:
pooya parsa
GitHub
parent
a1462fff39
commit
de17f1388c
|
|
@ -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. -->
|
||||
|
|
@ -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. -->
|
||||
|
|
@ -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
|
||||
|
|
@ -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.
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
<svg width="221" height="65" viewBox="0 0 221 65" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<foreignObject width="100%" height="100%">
|
||||
<div xmlns="http://www.w3.org/1999/xhtml">
|
||||
<style>@media (prefers-color-scheme: dark) { svg { color: white; } }</style>
|
||||
<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M76.333 20.5005H82.8185L96.5631 42.4764V20.5005H102.55V51.6393H96.1087L82.3198 29.7091V51.6393H76.333V20.5005Z" fill="currentColor"/>
|
||||
<path d="M129.311 51.6393H123.732V48.1611C122.462 50.6089 119.877 51.9871 116.612 51.9871C111.441 51.9871 108.083 48.3393 108.083 43.0894V29.2178H113.662V41.9416C113.662 45.0111 115.568 47.1459 118.425 47.1459C121.555 47.1459 123.732 44.7437 123.732 41.4524V29.2178H129.311V51.6393Z" fill="currentColor"/>
|
||||
<path d="M148.724 51.2848L143.372 43.811L138.019 51.2848H132.076L140.333 39.5849L132.712 28.8633H138.79L143.372 35.3154L147.906 28.8633H154.031L146.364 39.5849L154.62 51.2848H148.724Z" fill="currentColor"/>
|
||||
<path d="M165.96 22.4565V29.2173H172.311V33.7999H165.96V44.9302C165.96 45.304 166.111 45.6626 166.381 45.9271C166.65 46.1916 167.015 46.3405 167.397 46.3411H172.311V51.6302H168.636C163.646 51.6302 160.381 48.7824 160.381 43.8042V33.8043H155.891V29.2173H158.708C160.022 29.2173 160.787 28.45 160.787 27.1804V22.4565H165.96Z" fill="currentColor"/>
|
||||
<path d="M186.374 44.5872V20.5005H192.359V42.7416C192.359 48.748 189.411 51.6393 184.422 51.6393H177.455V46.3502H184.577C185.053 46.3502 185.511 46.1645 185.848 45.8339C186.185 45.5032 186.374 45.0548 186.374 44.5872" fill="currentColor"/>
|
||||
<path d="M195.945 41.1847H201.708C202.027 44.6629 204.386 46.8781 208.196 46.8781C211.598 46.8781 213.959 45.5455 213.959 42.7869C213.959 36.113 196.892 40.739 196.892 28.8174C196.896 23.7023 201.387 20.1479 207.839 20.1479C214.553 20.1479 219.088 23.9283 219.365 29.7565H213.633C213.363 27.0435 211.195 25.2196 207.828 25.2196C204.698 25.2196 202.748 26.6435 202.748 28.8218C202.748 35.7174 220.037 30.5609 220.037 42.7021C220.037 48.4846 215.182 51.9998 208.198 51.9998C200.986 51.9998 196.269 47.7281 195.952 41.189" fill="currentColor"/>
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M29.7513 14.261C28.0767 11.3817 23.8903 11.3817 22.2157 14.261L3.96535 45.641C2.29077 48.5204 4.38399 52.1195 7.73316 52.1195H21.9804C20.5493 50.8688 20.0193 48.7051 21.1023 46.8487L34.9243 23.1556L29.7513 14.261Z" fill="#80EEC0"/>
|
||||
<path d="M41.3151 21.1443C42.701 18.7885 46.1656 18.7885 47.5515 21.1443L62.6552 46.8188C64.0411 49.1746 62.3088 52.1194 59.537 52.1194H29.3296C26.5579 52.1194 24.8255 49.1746 26.2114 46.8188L41.3151 21.1443Z" fill="#00DC82"/>
|
||||
</svg>
|
||||
</div>
|
||||
</foreignObject>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.7 KiB |
70
README.md
70
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>
|
||||
|
||||
<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>
|
||||
|
||||
Welcome to Nuxt3 repository ✨
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
## 👀 Private beta
|
||||
|
||||
We are currently in private beta in order to stabilize the framework before onboarding the whole community.
|
||||
We are currently in private beta in order to stabilize the framework before opening to 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.
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
## 💡 Suggestions
|
||||
|
||||
Please create a [discussion](https://github.com/nuxt/framework/discussions/new) for improvements or feature requests.
|
||||
|
||||
## ❔ Questions
|
||||
|
||||
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`
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
<!-- ## 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.
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
# Getting Involved
|
||||
|
|
@ -1 +0,0 @@
|
|||
# Project Governance
|
||||
Loading…
Reference in New Issue