MDN Web Docs 기여 실습

번역 기여하기

MDN 번역 저장소에서 기여 가능

가이드라인 확인

MDN 기여 가이드 참고

로컬 환경 셋팅

• Fork & Clone

git clone https://github.com/[사용자네임]/content.git
git clone https://github.com/[사용자네임]/translated-content.git

• 작업 브랜치 생성 및 체크아웃

git checkout -b my-translation

• 환경 변수 설정 .env 파일 생성 및 내용 추가:

CONTENT_TRANSLATED_ROOT=/Users/[사용자명]/mdn_proj/translated-content/files
EDITOR=code

open in your editor 오류 발생시
대부분 맥에서 오류가 나는데, command+shift+p눌러서 명령 팔레트 열고 shell 검색

• 실행

yarn install
yarn start

• 로컬 문서 확인
  http://localhost:5042/ko/docs/Web 접속

• 편집
  화면에서 open in your editor 버튼 클릭 후 수정

이슈란?

이슈란?
GitHub의 Issue(이슈) 는 프로젝트의 작업, 개선 사항, 버그 제보 등을 관리하는 게시판 역할을 한다.
이슈를 통해 프로젝트의 진행 상황을 문서화하여, 다양한 상황에 효과적으로 대처할 수 있다.

• 이슈의 주요 기능
  담당자(Assignee), 라벨(Label) 등을 이용해 분류 가능
  협업 시 필수적인 커뮤니케이션 도구로 활용 가능

이슈 게시판 실습

GitHub 프로젝트 내 Issues 탭을 활용하여 이슈를 생성할 수 있다.

1. 저장소에서 Issues 탭 클릭
2. New Issue 버튼 클릭
3. 제목과 내용을 입력 후 Submit new issue 클릭

PR에서 이슈 활용하기

• PR(Pull Request)에 이슈 연결하기
  PR을 생성할 때 특정 이슈와 연결하면, PR이 병합될 때 해당 이슈가 자동으로 닫힌다.

• PR과 이슈 연결 키워드
  아래 키워드 중 하나를 사용하여 PR 본문에 이슈 번호를 입력하면 자동으로 연결된다.

• close / closes / closed

• fix / fixes / fixed

• resolve / resolves / resolved

ex)

Fixes #42

👉 PR이 병합되면 #42번 이슈가 자동으로 닫힘