Vuetify는 이슈를 남기고, Pull Request를 제출하거나, 소중한 피드백을 주는 놀라운 커뮤니티에 의해 만들어지고 있어요. 물론, 여러분들이 놀라운 애플리케이션을 만들 수 있도록 하는 것이 우리의 일이긴 하죠. 하지만 대부분의 경우, 여러분이 되려 더 나은 것을 만들 수 있다는 걸 발견하곤 했습니다. 가령 버그를 찾아주거나, 아니면 추가적인 기능에 대한 아이디어가 있듯이 말이에요. 아주 멋진 일이죠! 이를 위해 Vuetify 리포지토리를 clone하고, 작업 환경을 구성할 수 있는 방법을 알아보도록 하겠습니다.

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.

로컬에 개발 환경을 구성하는 건 간단해요! 먼저 Vuetify 리포지토리를 fork해 여러분의 리포지토리로 복사해주세요. 그리고 아래의 명령을 통해 여러분의 컴퓨터로 clone을 해주세요.

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:

자 이제 남은 건 개발 환경을 실행하는 것 뿐입니다!

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 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은 의미있는 버전 관리를 위해 유동적인 인터페이스를 제공합니다. 그리고 패치 노트를 더 쉽게 쓸 수 있게끔 하는 아주 훌륭한 예시를 제공해주고 있죠.

모든 commit은 언급한대로, commitizenconventional-changelog를 통해 진행해야만 합니다. 또한, commit은 <type>: <subject>또는 <type>(scope): <subject> 형태로 작성해주세요.

  • feat: 새로운 기능이 포함된 commit인 경우 사용합니다. 이전 버전과 호환되는 기능은 다음 MINOR 버전에서 릴리스되지만, 제대로 작동하지 않을 위험성이 있는 새로운 주요 기능들은 다음 MAJOR 버전에서 릴리스됩니다. 만약 제대로 작동하지 않을 위험성이 있는 사항인 경우, commit 메시지 본문이 BREAKING CHANGE로 시작해야만 하고 API가 어떻게 변경되는지 설명이 반드시 있어야만 합니다.
  • fix: Vuetify 코드 내 버그를 수정한 commit 사용합니다.
  • docs: 문서를 업데이트한 commit의 경우 사용합니다.
  • style: 코드 포맷 변경과 같이 실행에는 영향을 끼치지 않는 commit의 경우 사용합니다.
  • refactor: 버그를 수정하거나 기능을 추가하지 않는 commit인 경우 사용합니다.
  • perf: 성능 향상과 관련된 commit인 경우 사용합니다.
  • test: 누락되었거나, 기존의 테스트를 수정하는 commit인 경우 사용합니다.
  • chore: Other commits that don't modify src or test files.
  • revert: 이전 commit으로 되돌리는 경우 사용합니다.

여러분이 commit을 하기 전에, 항상 최신 버전인지 확인해주세요. 대부분의 충돌이 여기서 발생됩니다. 개발이 끊임없이 진행되기에, 자주 pull 해주는 것이 좋을거예요.

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를 한 다음, 새로운 pull request를 만들어주세요.

더 읽을 준비 되었나요? 그렇다면 아래 설명서를 더 읽어보세요!

Caught a mistake or want to contribute to the documentation? Edit Layout on GitHub!