Skip to content

Latest commit

 

History

History
148 lines (115 loc) · 10.5 KB

CONTRIBUTING.md

File metadata and controls

148 lines (115 loc) · 10.5 KB
Raw

멋진 파이써니스타 여러분! 프로젝트에 기여해주셔서 감사합니다.:tada: 파이콘 한국은 파이썬 커뮤니티의 많은 분들의 자발적인 도움으로 만들어가고 있습니다.:+1:

사전 준비

1. 저장소(Repository) 준비

  • 저장소 준비 전, git-cli 설치와 자신의 github 계정으로 로그인 과정이 필요합니다.
  1. 저장소를 포크(fork) 해주세요.

저장소 포크하기

  • 잠시만 기다리시면 로그인한 계정으로 저장소가 포크됩니다.

포크 중

  1. 포크된 자신의 저장소 주소를 확인합니다.

주소 확인

  1. 명령 프롬프트 등의 터미널을 실행한 뒤, 저장소를 복사할 디렉토리로 이동해주세요.

    • Shift + 우클릭 -> 여기에 명령창 실행 을 사용하시면 편리합니다.

  2. 아래 명령어를 순서대로 입력해주세요.

    • (<주소>는 알맞은 주소를 입력하신 뒤, 주석 부분은 제외하고 입력해주세요.)
    • 예시: git clone https://github.com/계정명/......
git clone <주소>              # 복사(clone) 명령

2. 작업 전 issue 생성

  • 중복 작업과 충돌(conflict) 방지를 위해 이슈를 생성하고, assignee를 자신으로 설정해주세요.
  • 이슈는 원래의 저장소인 pyconkr의 script 저장소에 생성해주시면 됩니다.
  • 이미 검수가 끝난 스크립트인지, 이미 할당되어있는 이슈가 아닌지 먼저 확인해주세요.
    • 검수가 끝난 스크립트의 경우, 스크립트 마지막 줄에 (검수완료)라고 적혀있습니다.
      • 심각한 오류가 있지 않은 스크립트라면 되도록 검수되지 않은 새로운 스크립트로 작업해주세요 :) 더 많은 영상작업을 진행하기 위해서입니다.
    • issue 탭에서 스크립트 파일이름으로 검색해주세요.
      • 만약 같은 이슈가 있다면, 예상완료일자가 지난 이슈인지 확인해주세요. 먼저 이슈할당자(Assignee)에게 comment로 작업 중인지 물어봐주세요. 작업 중이 아니라면 같은 제목으로 새롭게 이슈를 생성하시면 됩니다.
        • 작업 중이지 않은 이전 이슈는 maintainer가 close합니다.
  1. python/pycon-script 저장소에서 새로운 이슈를 생성합니다.

이슈 생성

  1. assign yourself를 클릭하시면 자신을 assignee로 추가할 수 있습니다.

assignee 할당

  1. 제목 등 필요한 내용을 기입하신 뒤 Submit new issue를 눌러주세요.

예제

기여를 위한 사전 작업이 완료되었습니다. 컴퓨터에 생성된 *.md 파일을 수정해주시면 됩니다.
커밋 후 PR(Pull Request)를 보내주시면 빠르게 반영하겠습니다.

스크립트 편집

  • 스크립트의 일부만 편집하는 기여도 가능합니다.
  • 오타 등을 제외하고는 발화 내용을 교정 및 편집하지 않도록 합니다.
    • 발표자의 의도를 최대한 해치지 않고 편집하기 위해서입니다. 세션 내용에 대한 의견이 있으시다면, 영상의 댓글로 남겨주세요. 😃
  1. 오,탈자 수정하기
  • 개발 용어는 영문으로 표기합니다.
    • 보다 자세한 표기에 대해서는 자막 용어집을 참조해주세요. 대표어로 표기하면 됩니다.
  • *, - 이나 발표자명이 발화 내용 앞에 적혀있을 경우 삭제합니다.
    • e.g., - 이것은 말이죠 / - 강종구 : 이 부분에서...
  • 통일된 표기법을 위해 표기법 문서를 참고해주세요.
  1. 스크립트에서 빠진 내용 추가하기
  • 문자통역 특성상 빠진 내용이 있을 수 있습니다. 최대한 발화내용과 가깝도록 빠진 내용을 추가해주세요.
  • 원본영상 링크는 각 스크립트의 상단에 있습니다.
  1. 스크립트의 문단과 행을 슬라이드 구간에 맞춰서 분리하기
  • 자막 작업 시 복사, 붙여넣기가 편하도록 문장을 나누고 공백열을 추가합니다.
  • 하나의 자막에서 최고 줄 수 : 2줄
  • 하나의 자막에서 최고 줄 길이 : 21 한국어 글자
  • 줄 바꾸기에서 언어적 단위를 자르지 말 것 (형용사구, 명사구, 절 등. 또한 끝문장과 시작 문장을 같이 넣지 말 것)
  • 자막 구조를 위해 한 문장의 끝부분과 다른 문장의 시작 부분을 한 자막에 합쳐 넣지 말 것
  • 텍스트 자르기 : 읽기 속도나 길이를 위해서 필요하지 않다면 문장을 너무 짧게 자르지 말 것 (한국어 글자가 14자 정도 이하면 너무 짧음)
  • 강연이 아닌 소리 재현을 하려면 소괄호 안에 넣을 것
  • 화면에 뜨는 텍스트는 대괄호 [] 에 넣을 것
  1. 작업내용 표시하기
  • 스크립트 일부만 편집했을 때
    • 편집한 스크립트 내용 앞에 줄을 추가해 (여기부터 검수 시작) 을 적어주시고 검수한 내용 마지막 줄에 (여기까지 검수 완료)를 추가해 적어주세요.
  • 스크립트 전체 편집이 완료되었을 때
    • 모든 내용이 검수 완료된 스크립트는 마지막 줄에 (검수완료) 라고 적어주세요.

Pull Request하는 방법

PR 전 확인해주세요

  • PR 관련한 issue를 먼저 생성해주세요.
  • 중복된 PR 이 없는지 확인해주세요.
  • 작업파일명은 repository의 파일명은 같게 해주세요.

모든 PR은

  • PR 내용에는 #이슈 번호 를 포함해 적어주세요.
  • Maintainer가 수정할 수 있도록 Allow edits from maintainers 항목을 체크해주세요.

Check Allow edits from maintainers

자막 스크립트 편집 PR

  • 작업할 수 있는 만큼만 편집해주시면 됩니다. 어디서부터 어디까지 편집했는지 꼭 파일에 적어주세요.
  • 스크립트 편집 기준

스크립트 일부만 편집했을 때

  • 편집한 스크립트 내용 앞에 줄을 추가해 (여기부터 검수 시작) 을 적어주시고 검수한 내용 마지막 줄에 (여기까지 검수 완료)를 추가해 적어주세요.
  • PR 제목은 [일부수정]파일 경로포함 파일명 으로 합니다. (예. [일부수정]2019-pyconkr/day2/라이트닝 토크/what is my PyCon - 배권한.txt)

스크립트 전체 편집이 완료되었을 때

  • 모든 내용이 검수 완료된 스크립트는 파일 내 마지막 줄에 (검수완료) 라고 적어주세요.
  • PR 제목은 [전체 편집]파일 경로포함 파일명 으로 합니다. (예. [전체편집]2019-pyconkr/day2/라이트닝 토크/what is my PyCon - 배권한.txt)

자막 파일을 유투브에 업로드 하는 방법

  • vrew를 사용해 SRT 자막 스크립트를 생성, 유투브에 업로드해서 자막 작업에 들어가는 공수를 줄여봅시다.
  1. 자막을 추가하려는 영상에서 우측 하단의 설정 아이콘을 클릭, 자막 - 자막 추가를 선택합니다.
    • 동영상 링크는 .txt 스크립트 파일의 상단에 있습니다.

Check Allow edits from maintainers

  1. 자막 언어를 한국어로 설정, 자막 입력 화면으로 이동합니다.

  2. 작업 - 파일 업로드를 클릭, 자막 파일을 선택합니다.

Check Allow edits from maintainers

  1. 내 번역 제출을 클릭하셔서 진행 상황을 저장합니다.
  • 자막 스크립트에 기여해주실 때는 유투브에서 자막 수정을 하신 후 자막 파일을 다운로드받아 깃헙에 업로드 해주세요.

참고자료.