Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vue.js 사용자 모임 기여 문서 작성 #42

Closed
ChangJoo-Park opened this issue Feb 3, 2017 · 3 comments
Closed

Vue.js 사용자 모임 기여 문서 작성 #42

ChangJoo-Park opened this issue Feb 3, 2017 · 3 comments

Comments

@ChangJoo-Park
Copy link
Member

No description provided.

@ChangJoo-Park ChangJoo-Park self-assigned this Feb 3, 2017
@ChangJoo-Park ChangJoo-Park changed the title Vue.js 사용자 모임 기여 문서 Vue.js 사용자 모임 기여 문서 작성 Feb 3, 2017
@ChangJoo-Park
Copy link
Member Author

현재까지 작성한 내용입니다.


기여(CONTRIBUTING)

본 문서는 Vue.js 한국어 사용자 모임에 대한 기여 방법을 다룹니다. 2017년 2월 3일자 최신.

프로젝트에 기여 전에 저장소의 관리자와 슬랙/페이스북/메일/이슈 등의 방법을 통해 변경하려는 내용에 대해 먼저 논의하는 것을 추천합니다. 이는 이미 진행 중인 작업을 중복으로 처리하는 것을 막기 위함입니다.

행동강령(CODE OF CONDUCT)

Vue.js 한국어 사용자 모임의 행동강령은 따로 존재하지 않습니다.
단, 항상 상대방을 먼저 생각하는 마음으로 대해주시면 좋겠습니다.

Github 사용자 모임 조직 멤버의 기준

Github vuejs-kr 조직의 멤버의 권한은 프로젝트 리뷰 및 머지까지 입니다. 누구나 함께할 수 있습니다.

멤버가 되는 기준은 현재(2017년 2월)까지의 기준은 다음과 같습니다.

  • Vue.js 프로젝트에 기여한 분
  • Vue.js 한국어 블로그에 포스트 및 코드조각을 올려주신 분

위 기준은 언제든지 변경 될 수 있으며 남을 비난하거나 강제할 권한은 없습니다.

프로젝트 범위

Vue.js 한국어 사용자 모임의 프로젝트 범위는 Github vuejs-kr 저장소를 기준으로 정합니다. 프로젝트별 기여 방법이 다릅니다. 이는 Vue.js 프로젝트를 관리하는 메인 Vue.js 조직의 한계입니다. 문서에 관한 내용은 코어 Vue.js 조직에서 인지하고 있습니다.

  • kr.vuejs.org : Vue.js의 한국어 공식 문서입니다.
  • vue-router : Vue.js의 컴패니언 라이브러리인 vue-router의 문서를 관리합니다. docs/kr에 문서가 있습니다.
  • vuex : Vue.js의 컴패니언 라이브러리인 vuex의 문서를 관리합니다. docs/kr에 문서가 있습니다.
  • vue-loader : 단일 파일 컴포넌트를 위한 vue-loader 입니다. docs/kr에 문서가 있습니다.
  • vue-cli :Vue.js의 커맨드라인 인터페이스 입니다. 가이드를 위해 README.md만 관리합니다.
  • vuejs-kr.github.io : Vue.js 한국어 사용자 모임의 공식 블로그 입니다.

각 프로젝트 별 기여 방법

kr.vuejs.org

Vue.js의 한글 가이드는 영문 가이드의 포크 프로젝트 입니다. 해당 프로젝트는 http://vuejs.org 의 최신 문서를 최대한 빠르게 반영하는 것을 목표로 합니다.

영문 공식 가이드의 내용이 추가되거나 삭제되는 부분은 현재 박창주가 관리합니다.

한국어 가이드를 수정하기 위해서 다음 절차를 따라 진행하세요.

  • 한국어 가이드 저장소를 포크
  • 잘못 된 부분 수정 후 커밋
  • 한국어 가이드 저장소에 Pull Request
포크한 로컬 저장소와 한국어 가이드를 최신 버전으로 유지하는 방법
git remote add upstream https://github.com/vuejs-kr/kr.vuejs.org
git fetch upstream
git merge upstream/master

vue-router와 vuex, vue-loader 그리고 vue-cli

vue-router, vuex vue-loader는 gitbook을 이용하여 문서를 만듭니다. 이 문서들은 한국어 저장소에 있으나 vuejs 코어 저장소에서 수정이 되어야 실제로 반영이 됩니다. vue-cli을 제외한 저장소는 일본어 공식 조직의 카즈야 카와구치(kazupon)의 리뷰를 거치게 됩니다. 한국어 문서의 경우 kazupon의 요청에 따라 박창주가 리뷰를 합니다. 빠른 갱신을 위해 수정시 미리 알려주시면 리뷰 과정이 간단해집니다.

한국어 문서를 수정하기 위한 절차는 다음과 같습니다.

  • 공식 조직의 해당 저장소를 포크하여 수정
  • Pull Request
  • 리뷰 후 머지

vuejs-kr.github.io 블로그

블로그에 대한 기여는 포스트/코드조각이 있습니다.

포스트의 경우

  • Github 이슈 확인
  • 이미 존재하는 이슈의 경우 할당 및 할당 요청 후 Pull Request
  • 없는 이슈의 경우 생성 후 Pull Request
  • 한국어 사용자 모임 Github 조직 멤버의 리뷰 후 머지
    Pull Request 할 포스트의 위치는 _posts 입니다.
    파일 이름은 작성연도-월-일-제목.markdown입니다. 현재 올라온 포스트들을 참조하신 후 요청해주세요.

코드조각의 경우

기부

이 링크를 통해 기부를 받고 있습니다. 투명한 사용 내역 공개를 위해 ko-fi를 사용하고 있습니다. 기부금은 세미나가 열릴 경우에 사용합니다. 사용 시 모든 내역은 공개된 채널(슬랙/페이스북)에 공개합니다.

금전적인 기부 이외에 세미나 장소등에 대한 기부도 환영합니다.

@ChangJoo-Park
Copy link
Member Author

#31 이슈는 이 이슈와 통합합니다

@ChangJoo-Park
Copy link
Member Author

참여 방법에 대한 설명 #15 이슈와 함께 봐주세요

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants