[p5.js KO] 풀 리퀘스트 및 리뷰 과정 안내 (마지막 업데이트: 5월 1일 12:23)

[yinhwa]

풀 리퀘스트(Pull Request, PR)란 무엇인가요? link

번역 PR 및 리뷰 진행 순서

• 요약: PR 최초 게시(init) > 스튜어드 2인 및 공동 기여자 쓰기 권한 공유 >1차 번역 커밋 > 1차 리뷰 코멘트 > 1차 리뷰 반영한 2차 번역 커밋 > 2차 리뷰 코멘트 (또는 생략 후 스튜어드 승인) [> 2차 리뷰 반영한 3차 반영 커밋 > 스튜어드 승인] > maintainer 최종 PR 머징 및 processing > p5.js > contributor_docs 게시

1. 2차 과제: https://github.com/bocoup/p5.js-website/tree/main/src/content/reference/ko/p5 접속

• 1차 과제: 프로세싱 재단 GitHub Organization > p5.js > contributor_docs > ko 폴더가 아닙니다.

2. 페이지 상단 우측 Add file > Create new file 클릭, Fork this repository 클릭

• Fork : 원본 repo를 여러분 개인 깃허브에 복사뜬다고 생각하면됩니다. (고로, 이하 모든 작업은 최종적으로 재단에서 머징하기 전까지 사실상 여러분 개인(local) repo에서 진행되는 것과도 같습니다!)
  

3. 로컬 포크 쓰기 권한 공유

• (하나의 MD/X 파일을 2인이상 번역하는 경우, 먼저 PR 생성하신) 기여자님은 자신의 로컬 포크에 대한 쓰기 권한을 이 가이드라인(@limzykenneth 님 제공)에 따라, 스튜어드 2인 @yinhwa @designerSejinOH 과 (해당시) 협업 기여자님께 공유합니다.

4. 파일내 영어 원문 복붙을 포함한 번역 MD/X 파일 PR 초기화(첫 게시)

• (하나의 MD/X 파일을 2인이상 번역하는 경우 해당 파일 앞부분을 번역하시는 분이) 아래의 가이드라인에 따라 MD/X 파일 PR을 생성, 영어 원문 전체를 복붙후 커밋합니다.
  ⚠️ 영어 원문 복붙 방법: 해당 원문 MD/X파일 우측 상단 Edit this file (연필 아이콘) 클릭후 내용 전체 복사
  ⚠️ 파일명: 해당 원문 MD/X파일의 파일명과 동일하게 유지
  ⚠️ 최종 PR상에는 영어 원문은 제거하시고 한글 번역문만 포함하시면 됩니다! 단, 용의한 리뷰를 위해 영어 원문의 ⭐코드 라인 넘버링 위치⭐는 가능하다면 유지해주세요!

• 이하 방법에 따라 초기화 커밋 완료후 나머지 번역은 추가 커밋으로 진행해주시면 됩니다.

5. Commit 설정창에서 아래와같이 선택 후 Propose changes 버튼 클릭

또는

• 윤영님의 제보에 따르면, 최초 포킹한 후에는 이렇게 뜨는것 같습니다. 마찬가지로 Propose changes 누르시면 됩니다.

6. 위 버튼 클릭 후 나타나는 Open Pull Request 페이지 상단 "Able to merge" 초록등 여부 확인,

7. 제목(title), 본문 중 변경사항(changes) 간단히 작성 및 PR Checklist [x] 표기 후 Create pull request 버튼 클릭

⚠️ Add a title : "[p5.js KO] 디폴트 제목"

⚠️ Add a description : 디폴트 템플릿에 따른 PR 게시글 본문 작성 방법

1. Changes: 변경사항만 간단히 입력 (한글/영어 무관)
2. PR Checklist 에 이상없을시 [x] 표기
3. 스크린샷은 스킵하셔도됩니다. 위의 1), 2)에 해당하는 내용 외 나머지 처리 및 각주 안에 있는 내용은 지우셔도됩니다.

PR 게시글 본문 디폴트 템플릿

<!--
  Thank you for contributing! Please use this pull request (PR) template.


 In the description field of this PR, include "resolves #XXXX" tagging the issue you are fixing. If this PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".-->
Resolves #[Add issue number here]

 Changes:
<!-- Add here what changes were made in this pull request and if possible provide links showcasing the changes. -->


 Screenshots of the change:
<!-- If applicable, add screenshots depicting the changes. -->

#### PR Checklist
<!--
  To check any option, replace the "[ ]" with a "[x]". Be sure to check out how it looks in the Preview tab! Feel free to remove any portion of the template that is not relevant for your issue.
-->

- [ ] `npm run lint` passes
- [ ] [Inline documentation] is included / updated
- [ ] [Unit tests] are included / updated

[Inline documentation]: https://github.com/processing/p5.js/blob/main/contributor_docs/inline_documentation.md
[Unit tests]: https://github.com/processing/p5.js/tree/main/contributor_docs#unit-tests

작성 예시:

Changes: init contributor_guidelines.md

- [x] `npm run lint` passes
- [x] [Inline documentation] is included / updated

8. Create pull request 후 PR 게시 페이지상 모든 conflict check (최대 5분 소요) 모든 항목이 초록등으로 켜지는지 여부 확인

• 이제 여러분의 PR이 processing > p5.js > Pull Request 게시판에 게시되었습니다.
• 여러분의 PR 게시글상 곧바로 conflict check 이 자동실행되는데요, 그냥 놔두고 기다리시면 됩니다. (최대 5분 소요)
• 모든 conflict check 항목이 통과하면, "All checkes have passed✅", "This branch has no conflicts with the base branch✅" 라고 뜹니다! 원활한 머징을 위해 이 2개 모두 ✅표시 뜨는지 확인 필요합니다.
  ⚠️ 주의: Approve and run 또는 Merge pull request 버튼은 누르지 말아주세요! 스튜어드 번역문 리뷰 및 최종 버전 컨펌후 재단측에서 직접 merge합니다.

9. Conflict check 후 PR 게시 페이지 하단 Comment 창에서 스튜어드 2인 @yinhwa @designerSejinOH 을 멘션해주시면, 스튜어드가 곧바로 리뷰하러갑니다.

• 영어 원문 MD/X 파일에 대한 질문 또는 논의사항이 있다면, 해당 내용을 PR 게시글상 영문 댓글에 작성하시고 재단측 maintainer인 @Qianqianye, @limzykenneth 님을 함께 멘션해주셔도 좋습니다!

10. 번역 작업 재개 및 수정을 위한 PR 게시글 수정하기

• `PR 게시글 > Commit > 수정하고자하는 Commit 파일 클릭 > 우측 상단 ... 아이콘 클릭 > Edit this file (아래 이미지 참고)
• 에디터 파일상 번역 작업 재개 및 수정하신 후, 우측 상단 Commit changes 클릭하여 위의 7번 순서부터 그대로 다시 PR
  

11. 원문 복붙 후 최초 PR시 + 이후 N차 번역 커밋 완료시 반드시 댓글창에 스튜어드 2인 @yinhwa @designerSejinOH 을 멘션해주세요!

• PR 게시글 1개당 스튜어드 리뷰는 스튜어드 2인 X 1회 X 최소 1시간 = 최소 2회 (최소 2시간)인 점, 그리고 기여자님들의 리뷰 코멘트 반영 시간을 고려하셔서 번역 작업을 진행해주시면 좋겠습니다 :)

• 번역 및 리뷰 진행 순서: PR 최초 게시(init) > 1차 번역 커밋 > 1차 리뷰 코멘트 > 1차 리뷰 반영한 2차 번역 커밋 > 2차 리뷰 코멘트 (또는 생략 후 스튜어드 승인) [> 2차 리뷰 반영한 3차 반영 커밋 > 스튜어드 승인] > maintainer 최종 PR 머징 및 processing > p5.js > contributor_docs 게시

12. 스튜어드 리뷰에 따른 PR 수정 방법

• 스튜어드는 기여자님이 커밋하신 코드 라인 단위로 리뷰 댓글을 작성합니다. (아래 1번째 이미지 참고)
• 각 리뷰 댓글을 확인하신 후 "resolve" 합니다. (기여자님은 필요시 댓댓글을 작성하셔도 됩니다!)
• 모든 리뷰 댓글을 "resolve"한 후, 다시 "Commit changes" 버튼 클릭 > 설정: 기존 로컬 브랜치(브랜치명 예시: patch-1)로 direct commit합니다. (아래 2번째 이미지 참고)
• 리뷰 커밋 진행 후 반드시 댓글창에 스튜어드 2인 @yinhwa @designerSejinOH 을 멘션해주세요!

13. 스튜어드 번역문 리뷰 및 최종 버전 컨펌후 재단측에서 Merge pull request

참고사항 (24.05.01 추가)

• 파일 내 특정 단어 여러개를 일괄적으로 변경해야될 시, Ctrl+F 단축키를 활용하여 해당 단어를 찾고, 모든 단어 변경 적용도 가능합니다.