Skip to content
This repository has been archived by the owner on Apr 18, 2021. It is now read-only.

Latest commit

 

History

History
120 lines (85 loc) · 4.68 KB

CONTRIBUTING-ko.md

File metadata and controls

120 lines (85 loc) · 4.68 KB
Raw

Contributing to vvisp

English version: CONTRIBUTING.md

vvisp에 기여하시려는 모든 개발자분들을 환영합니다. 오늘 보다 더 나은 vvisp을 위해 여러분의 많은 도움이 필요합니다. vvisp에 기여하기위한 가이드라인을 제공합니다.

Prerequisites

Install modules:

$ npm install -g lerna
$ cd vvisp
$ npm run bootstrap

Question or Problem?

Github Issue는 버그 리포트와 기능 요청에 사용합니다. 따라서 단순한 질문이나 코드에 대한 궁금증을 위해 Issue를 오픈하는 것은 삼가해주세요.

Issues and Bugs?

소스 코드에서 버그를 찾으시면 Github 저장소에서 Issue를 오픈해주세요. 이슈 오픈 이후에 버그를 수정해서 Pull Request를 보내주시면 더 큰 힘이 됩니다.

Submission Guidelines

Submitting an Issue

Issue를 오픈하기 전에 issue tracker에 중복되는 이슈가 있는지 살펴봐주세요. 동일한 이슈가 있다면 workaround나 Pull Request가 있을 수 잇으니 미리 준비된 해결책을 적용하세요. 중복되는 이슈가 없다면 새롭게 이슈를 생성해주세요.

Issue 카테고리는 다음과 같습니다.

  • Regression (a behavior that used to work and stopped working in a new release)
  • Bug report
  • Performance issue
  • Feature request
  • Documentation issue or request
  • Other

만약 버그에 대한 이슈를 생성하신다면 최소한의 재현 경로를 포함해주세요. 여러분의 작은 노력의 저희가 더 좋은 개발 도구를 만들기 위해 큰 도움이 됩니다. 이슈를 생성해주시면 최대한 빠른 시일내에 답변을 하고 개선점을 찾도록 하겠습니다.

새로운 이슈를 생성하기 위해서 Issue Form을 채워주세요.

Submitting a Pull Request (PR)

아래의 가이드라인에 맞춰 PR을 생성해주세요.

  1. Github PR 목록에서 중복되는 PR이 있는지 확인해주세요. Open/Closed PR 모두를 참고해주세요.

  2. HAECHI-LABS/vvisp 저장소를 fork 하세요.

  3. 새로운 git branch를 만들고 코드를 추가 및 수정하세요.

    git checkout -b new-branch master

  4. 적절한 테스트 케이스를 작성해주세요.

  5. 테스트 케이스를 작동시켜서 모든 테스트가 성공하는지 확인해주세요.

  6. Commit 메세지 규칙에 맞게 commit 메세지를 작성해주세요.

    git commit -a

  7. GitHub에 새 브랜치를 push 하세요:

    git push origin new-branch

  8. GitHub 에서 vvisp:dev로 pull request를 보내주세요. pull request 를 보내기 전에 브랜치를 rebase하고 force push해주세요.

    git rebase master -i
git push -f

Commit Message Guidelines

잘 정돈된 커밋 메세지는 가독성을 올려주고 여러 오픈 소스 개발자들 코드의 변경사항을 쉽게 이해할 수 있게 도와줍니다. 또한, 컨벤션에 맞춰진 커밋 메세지로 새로운 버전 배포시 변경 로그 문서를 자동으로 생성할 수 있습니다. vvisp의 커밋 메세지는 conventional commits를 따릅니다.

Commit Message Format

<type>[optional scope]: <description>

[optional body]

[optional footer]

예제:

docs: correct spelling of CHANGELOG                 


fix: minor typos in code

see the issue for details on the typos fixed

fixes issue #12

Type

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • chore: Extra works
  • ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Revert some updates
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

자세한 내용은 conventional commits를 참조하세요.