# Contributing

Vuetify is made possible by an amazing community that submits issues, creates pull requests, and provides invaluable feedback. It is our job to enable you to create amazing applications. A lot of the time, you come across something that can be made better. Maybe you find a bug, or you have an idea for additional functionality. That’s great! It’s as easy as cloning the Vuetify repository to get started working in a development environment.

# Reporting Issues

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:

  • Search for a similar issues, it may have been answered.
  • Try to reproduce with the latest or lts (long-term-support) version in a codepen or repository that can be be cloned to produced the expected behavior.
  • The reproduction is MINIMAL and concise

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.

# 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

# 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

# Commit Guidelines with Commitizen

Commitizen provides a fluid interface for handling semantic versioning. This provides a great boilerplate making it easier to write patch notes.

All commits should use commitizen with the conventional-changelog as noted above. Commits should follow the format <type>: <subject> or <type>(scope): <subject>

# Commit types

  • feat: Commits that result in a new features or functionalities. Backwards compatible features will release with the next MINOR whereas breaking changes will be in the next MAJOR. The body of a commit with breaking changes must begin with BREAKING CHANGE, followed by a description of how the API has changed.
  • fix: Commits that provide fixes for bugs within vuetify’s codebase.
  • docs: Commits that provide updates to the docs.
  • style: Commits that do not affect how the code runs, these are simply changes to formatting.
  • refactor: Commits that neither fixes a bug nor adds a feature.
  • perf: Commits that improve performance.
  • test: Commits that add missing or correct existing tests.
  • chore: Other commits that don’t modify src or test files.
  • revert: Commits that revert previous commits.

# Submitting Changes / Pull Requests

Before doing any commits, you will want to pull down the latest and greatest from dev. From here, merge, and resolve any conflicts between your branch and dev. Its a good rule of thumb to pull frequently as development is constantly happening.

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)

Lastly, git push and open a pull request.

# Pull Requests For Vuetify

# Pull Requests For Docs

# Pull Requests For Docs - Language

Ready for more?

Continue your learning with related content selected by the Team or move between pages by using the navigation links below.
Edit this page on GitHub
Last updated:07/08/2020, 2:47:50 PM