Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.24 KB

contributing.md

File metadata and controls

38 lines (29 loc) · 2.24 KB
Raw

Contributing Guide

  1. Make sure you put things in the right category!
  2. Always add your items to the end of a list. To be fair, the order is first-come-first-serve.
  3. If you think something belongs in the wrong category, or think there needs to be a new category, feel free to edit things too.
  4. Do not use words that are clearly implied in the description, such as for Vite or Vite plugin.
  5. The description should be short (one sentence in 24 words, no expanded explanation) and meaningful without using emoji.
  6. Do not use words that are not relevant to the description such as Super-Fast or Super-Super-Fast.

Projects using Vite.js

Make sure you put things in the right category. There are two main categories:

  • Open Source
  • Apps/Websites

Open source

Open Source section gives the possibility for developers to contribute and be a part of an opensource project using their knowledge of the Vite. You should put your project in this category if the following conditions are true:

  • The description for the link should not contain links to the author and third-party resources - this should be in the documentation (README).
  • The documentation (README) contains a description of the project, illustration of the project with a demo or screenshots and a CONTRIBUTING section.
  • The documentation is in English.
  • The project is active and maintained.
  • The project accepts contributions.
  • Not a commercial product.

The link provided should be the link of the github repository, not the demo. If you consider your project finished, and it does not need any contributions, consider the apps/website category.

Apps/Websites

Apps/Websites gives the opportunity to showcase the awesome things we can build with Vite. You should put your app/website in this category if the following conditions are true:

  • The website is available without errors or ssl certificate problems, and load in a reasonable amount of time.
  • The website is using Vite intensively.
  • The website is original and not too simple. For that reason, blogs and simple landing pages are rejected.
  • A commercial product using Vite, provided that guests could reasonably check out how Vite was used (i.e. A headless CMS which uses Vite for the Admin/editor Area and offers a free tier).