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.
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.
If you are making a Pull Request, please fork the Vuetify repository before continuing; More information on forking repositories is located in the Fork a Repo documentation. Otherwise you can simply click the Clone or download option on the Vuetify repository page.
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:
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.
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:
Sometimes creating a
.czrc file does not work using the command prompt. If you get unexpected results, create the file in your user folder located in the home directory. This is typically located on your primary harddrive in the
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 provides a fluid interface for handling semantic versioning. This provides a great boilerplate making it easier to write patch notes.
- 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.
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)
git push and open a pull request.
Pull requests related to Vuetify:
- For bug fixes and documentation updates submit pull requests to
- For new features and enhancements submit pull requests to
- For bugs and critical fixes related to v1.5/LTS submit pull requests to
- For any features that contain breaking changes submit pull requests to
For any pull requests related to Vuetify docs, submit your pull request to the
We do not accept PR's for any doc changes pertaining to language other than
en. All changes for languages other than
en are to be submitting through our Crowdin project. To get started simply select
Help Translate in the language drop down of the docs. Languages will not be added until having more than 15% of their translations completed.
Ready for more? Continue reading with: