참여방법에 관한 설명서

[devjin0617]

해당 페이지에 기여, 등록 등을 진행하기 위해서 참여방법 가이드를 확인할 수 있는 페이지가 있으면 좋을 것 같습니다.

예를 들어 이슈등록방법, PR방법, Review후 Merge진행형식 등이 생각나네요

[ChangJoo-Park]

고민해봐야겠어요

[kciter]

CONTRIBUTING.md 문서에 아래와 같이 적는건 어떨까요? 흔히 나와있는 내용 중 기여 방법에 대한 내용만 이 레포에 맞게 수정해봤습니다.

Vue.js Korea 블로그 기여 가이드

Vue.js Korea 블로그에 기여하고 싶으신 분들은 아래 가이드를 먼저 읽어주세요. :)

기여 방법

1. 먼저 vuejs-kr.github.io 저장소를 fork 합니다.
2. master 브랜치 기반으로 토픽 브랜치를 생성합니다.
   git branch my-topic-branch master
3. 추가/수정이 완료되면 jekyll serve를 통해 서버를 실행시키고 추가/수정하신 문서를 확인해주세요.
4. 확인되었다면 commit 합니다.
   git commit -am "참여 방법에 관한 설명서"
5. 만약 큰 의미가 없는 (e.g. 오타 수정) 여러 커밋이 겹쳐있다면 rebase와 squash를 이용하여 하나의 커밋으로 합쳐주세요.
   git rebase -i HEAD~2
6. 관련 이슈가 있다면 commit 할 때 이슈 번호를 적어주세요.
   git commit -am "이슈 #123 - 참여 방법에 관한 설명서"
7. 문제가 없다면 토픽 브랜치에 push 합니다.
   git push origin my-topic-branch
8. 그 후 vuejs-kr.github.io 저장소 master 브랜치에 Pull Request를 보냅니다. 🎉

[ChangJoo-Park]

빠른 시일안에 추가 해놓긴 해야겠다고 생각하고있었어요 의견 주셔서 감사합니다 👍

[devjin0617]

오 가이드 감사합니다.
저도 머리속에 생각나는 것들 적어놓고 있었는데, 여기에 계속 쌓아놓으면 되겠네요 : )

---

참여 대상

• Vuejs를 사용하고, 한국에 널리 전파하려는 목적이 있다면 참여 대상에 해당됩니다.
• 단순 번역작업 뿐만 아니라 여러분야로 참여하실 수 있습니다.
• 의견이 있을 경우 이슈에 등록하여 진행합니다.

vuejs-korea 참여를 시작하기 전에

현재 진행중인 작업물은 가이드 번역, 예제코드조각, Vuejs관련 포스트, 그외 Vuejs관련 번역들이 진행되고 있습니다.
Vuejs를 사용하면서 반복적인 실수, 질문들을 최소화하기 위하여 최대한 많은 정보를 모아두려는 목적이 있습니다.

• 의견이 있거나 진행하려는 작업이 있다면 이슈에 먼저 등록해서 진행하시면 됩니다.

참여 방법

• vuejs-kr.github.io를 개인 저장소로 Fork를 진행합니다.
• 각 필요한 작업에 따라 commit을 진행합니다. 이때, branch는 따로 생성하여 진행합니다.
  • 포스트: _posts/YYYY-MM-DD-subject.markdown의 형식으로 문서를 작성합니다. 공백은 -로 대체합니다.
  • 코드조각: snippets.md파일에 기존 등록되어 있는 코드조각 스타일에 따라 하단에 jsfiddle, github user link를 포함하여 등록합니다.
  • 한국어 번영 프로젝트 목록: 본인이 진행하고 있거나, 이미 번역되어 있는 프로젝트를 발견한다면 관련내용을 추가합니다.

주의사항

• 여기에는 자주 실수하는 내용들을...

vuejs-korea 관련 웹사이트

• 관련 URL들...

[kciter]

번역 관련된 가이드로 다음은 어떨까 합니다. :)

번역 스타일

• 존댓말을 기준으로 작업합니다.
• 맞춤법/문법 검사를 합니다. 부산대 한국어 맞춤법/문법 검사기
• 외래어의 경우 꼭 외래어 표기법에 맞출 필요 없이 융통성있게 작업합니다.
• 개발 용어의 경우 한국어로 표기하기 어색할 경우에는 영문으로 적습니다.

[devjin0617]

이슈등록, PR등록시 글 작성 방법의 대해서도 같이 고민하면 좋을 것 같습니다.
예) 번역: 공식홈페이지 최신뉴스 YYYY-MM-DD (#이슈번호)

그리고 저도 이슈, 커밋/푸시, PR요청시 놓쳤던 부분인데 커밋메시지에도 이슈번호를 같이 기입하고, 커밋메시지도 어느정도 통일하는방법도 같이 작성되면 좋을 것 같습니다.

[ChangJoo-Park]

네 자동으로 이슈 템플릿을 추가해놓으면 될거같아요
커밋 메시지에 사실 적어놔야하는데 까먹더라구요

[devjin0617]

PR #32 에 언급되었던 간단한 수정, 스니펫, 문서 등록시 멤버, 컨트리뷰터가 어디까지 따로 의견취합받지 않고 진행가능한지도 포함되어야합니다.