Contributing Guide

The issue list of this repo is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately. Before reporting an issue, ensure that:

These steps ensure that we have all of the information necessary to quickly triage and resolve your issue. Once your reproduction is complete, submit a new issue using the Vuetify Issue Creator.

Configurer votre environnement de développement est facile ! Pour démarrer, dupliquez (fork) Vuetify dans votre propre répertoire.

If you are new to the process of contributing to Open Source, it's recommended that you clone using https. More information on Which remote URL to use can be found on the GitHub documenation page.

Once cloned, navigate to the folder by typing cd vuetify and then running the following commands:

Vous êtes maintenant prêt à démarrer votre environnement de développement !

There are a few ways to startup the dev environments in Vuetify mono-repo. If you are using our PM2 guide, you can skip this section.

The following are recommended packages to use when developing in Vuetify:

The Vuetify team uses Commitizen for all repository commits. This allows for easy to read and organized commits with minimal change to normal commit functions. To get started, globally install the commitizen package using yarn by running the following commands in your terminal:

Congrats! Commitizen is installed! When you do commits, add your files like normal and replace git commit -m "your message" with git cz and follow the prompts.

More information on Commit Guidelines w/Commitizen can be found below.

When working with Vuetify it is common to have the Playground, Documentation, and Build running at the same time. PM2 improves this process by running the dev processes for each package automatically. To get started, globally install the pm2 package by running the folowing commands:

Once installed, start the Vuetify ecosystem file with the following commands:

You can check the status and many other options for your PM2 instances by using any of the following commands:

Commitizen fournit une interface fluide pour gérer le contrôle de version sémantique. Ceci fournit un excellent passe-partout facilitant la rédaction de notes de patch.

Tous les commits doivent utiliser commitizen avec le conventional-changelog, comme indiqué dans la note au-dessus. Les validations doivent suivre le format <type>: <sujet> ou <type> (portée): <sujet>

– feat: ** Commits qui donnent lieu à de nouvelles fonctionnalités. Les fonctionnalités rétrocompatibles seront publiées avec la prochaine version **MINEURE, tandis que les modifications les plus importantes seront apportées à la prochaine version MAJEURE. Le corps d'un commit avec des changements importants doit commencer par BREAKING CHANGE, suivi d'une description de la façon dont l'API a changé.

– *fix : * Commits qui corrigent des bugs dans le code de Vuetify.

– docs : Commits fournissant des mises à jour de la documentation.

– style : Commits n'affectant pas le fonctionnement du code, il s'agit simplement de modifications de la mise en forme.

– refactor : Commits qui ne corrigent ni un bug ni ajoute une fonctionnalité.

– *perf: * Commits qui améliorent les performances.

– test : Commits qui ajoutent des tests ou corrigent ceux existants.

• chore: Other commits that don't modify src or test files.

– revert : Commits qui annulent les commits précédents.

Avant de faire des commits, vous aurez besoin de récupérer les dernières nouveautés de la branche dev. À partir de là, fusionnez et résolvez tous les conflits entre votre branche et dev. C'est une bonne pratique de récupérer fréquemment les modifications car le développement se produit constamment.

In git, add all relevant files.

Commit with commitizen using the command git cz. From here you will follow through a series of props. Make sure to select the appropriate type (see Commit Guidelines w/Commitizen above)

Enfin, git push et ouvrez une demande de fusion.