Anleitung zur Mitarbeit

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.

Das Einrichten Ihrer Entwicklungsumgebung ist einfach! Um zu starten forken Sie Vuetify in Ihr eigenes Repository.

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:

Jetzt können Sie Ihre Entwicklungsumgebung starten!

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 bietet eine flüssige Schnittstelle für die semantische Versionierung. Dies bietet eine großartige Boilerplate, die das Schreiben von Patchnotizen erleichtert.

Wie bereits genannt sollten alle Commits commitizen mit dem conventional-changelog benutzen. Commits sollten im Format <type>: <subject> oder <type>(scope): <subject> geschrieben werden

• feat: Commits, die zu neuen Features oder Funktionen führen. Abwärtskompatible Funktionen werden mit dem nächsten MINOR veröffentlicht, während wichtige Änderungen im nächsten MAJOR vorgenommen werden. Der Hauptteil eines Commits mit fehlerhaften Änderungen muss mit BREAKING CHANGE beginnen, gefolgt von einer Beschreibung, wie sich die API geändert hat.

• fix: Commits, die Fehlerbehebungen in der Codebasis von vuetify beheben.

• docs: Commits, die Aktualisierungen der Dokumente bereitstellen.

• style: Commits, die keinen Einfluss auf die Ausführung des Codes haben, diese sind lediglich Änderungen an der Formatierung.

• refactor: Commits, die weder einen Fehler beheben noch eine Funktion hinzufügen.

• perf: Commits, die die Leistung verbessern.

• test: Commits, die fehlende Tests hinzufügen oder vorhandene Tests korrigieren.

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

• revert: Commits, die vorherige Commits rückgängig machen.

Bevor Sie Commits ausführen, sollten Sie das Neueste und Beste von dev herunterladen. Führen Sie von hier aus Konflikte zwischen Ihrem Zweig und dem Entwickler zusammen und korrigieren Sie diese. Es ist eine gute Faustregel, häufig zu aktualisieren, da die Entwicklung ständig stattfindet.

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)

Zuletzt, git push und Eröffnen eines Pull Requests.