# Contributing

# Setting up your environment

If you are making a pull request, please fork the Vuetify repository before continuing; More information on forking repositories can be found in the GitHub documentation.

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 documentation page.

# Example of cloning the Vuetify repository (non fork)

# Using HTTPS
git clone https://github.com/vuetifyjs/vuetify.git

# Using SSH
git clone git@github.com:vuetifyjs/vuetify.git

Once cloned, run the following commands:

# Navigate to the vuetify folder
cd vuetify

# Install all project dependencies
yarn

# Build the packages
yarn build

The build process compiles all of the Vuetify packages for development and may take awhile (grab some ☕). Once the packages are built, start your local development server by running yarn dev in the terminal.

# Starting your environment

There are a few ways to start the development environments in the Vuetify mono-repo.

# All commands run from root directory

# To start Vuetify dev
yarn dev

# To access your local vuetify playground: http://localhost:8080

# To start docs
yarn dev docs

# To access your local docs environment: http://localhost:8095

# To start a specific package
yarn dev <package name>

# To build all packages
yarn build

# To build a specific package
yarn build <package name>

# Package alias
api-generator: api

# Playground.vue

The Playground file is a cleanroom used for Vuetify development and is the recommended way to iterate on changes within the framework.

<template>
  <v-container>
    <!--  -->
  </v-container>
</template>

<script>
  export default {
    data: () => ({
      //
    }),
  }
</script>

The App.vue file used for Vuetify development is located in packages/vuetify/dev/. It contains a v-app and v-main component and the local Playground.vue file.

# Issue triage

With the size and popularity of Vuetify has come a constant influx of new issues, questions, and feature requests. To organize these requests the Core Team developed tools to aid not only the triaging of issues, but creating them as well.

The Issues board makes heavy use of the label system with some light automation; such as adding the triage label to new issues.

# Creating a pull request

# Requesting new features

Vuetify uses the RFC (request for comments) process for new feature suggestions. It is intended to provide a consistent and controlled path for new features to enter the framework.

Many changes, including bug fixes and documentation improvements can be implemented and reviewed via the normal GitHub pull request workflow.

Some changes though are substantial, and we ask that these be put through a bit of a design process and produce a consensus among the Vuetify Core Team and the community.

# Submitting Changes / Pull Requests

When submitting a pull request it is important that your local fork is synced with the latest changes in Vuetify. A pull request should be free of unnecessary commits and follow the conventional-changelog standards using the angular preset.

# VSCode tasks

More to follow…

# Process Manager 2

More to follow…

# Commitizen

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. Commitizen provides a fluid interface for handling semantic versioning and makes it easier to write release notes.

To get started, globally install the commitizen package using yarn by running the following commands in your terminal:

# Install commitizen and the conventional changelog adapter
yarn global add commitizen cz-conventional-changelog

# Then create a .czrc file that tells commitizen
# which adapter to use globally.
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

Once complete, instead of using git commit you will run the command git cz in your terminal. From here, you are presented with a series of prompts used to build the commit message. For additional information, please review our guidlines on commits.