[TIL] 20240625 - MDN Web Docs 기여 실습(1)

오픈소스

---

오픈소스는 누구나 자유롭게 접근하여 수정하고 배포할 수 있는 소스코드
ex. Linux, mongoDB, Chrome Engine, Bootstrap

🧊 Markdown

Markdown은 텍스트 형식 구문의 가벼운 마크업 언어로 문서 작업에 주로 사용
ex. README.md

# 제목1
## 제목2
### 제목3

> 인용

- 리스트1
- 리스트2

1. 순서1
2. 순서2

🧊 git

git은 소스코드 버전 관리 시스템(Version Control System, VCS) 도구

명령어

• git clone : 원격 저장소의 소스코드를 로컬 저장소로 복제해오는 명령어

• git add : 작업 디렉토리에서 변경한 내용을 스테이징 영역에 추가하는 명령어

• git commit : 스테이징 영역에 저장되어 있는 변경 사항들을 로컬 저장소에 등록하는 명령어

• git push : 로컬 저장소에 등록된 파일들을 원격 저장소에 올리는 명령어
  
  

🧊 GitHub

GitHub는 분산 버전 관리 툴인 git을 사용하는 프로젝트를 지원하는 웹호스팅 서비스

기능

• Fork : 원본을 복제해서 깃허브의 내 저장소로 가져오는 기능
• Issue : 저장소 안의 이슈에 대해서 처리하는 기능
• PR(Pull Request) : 소스 코드를 merge 하기 전에 검토하는 기능

MDN(Mozilla Developer Network) Web Docs

---

MDN Web Docs는 다양한 웹 개발 자료를 담고 있는 개발자 커뮤니티 사이트

• https://github.com/mdn/translated-content/blob/main/docs/ko/README.md

• https://github.com/mdn/translated-content/issues/827
  
  

🧊 MDN 기여 준비

Git(https://git-scm.com)

Node.js(https://nodejs.org/ko)

Yarn(https://yarnpkg.com)

VSCode(https://code.visualstudio.com)

🧊 로컬 환경 세팅

문서 저장소 두 곳에 대해 Fork & Clone

• 원문자료 : https://github.com/mdn/content
• 번역자료 : https://github.com/mdn/translated-content

git clone https://github.com/[username]/content
git clone https://github.com/[username]/translated-content

VSCode에서 폴더 열고 작업 브랜치 생성 후 체크아웃

git checkout -b [comment]

# 위의 명령어와 같은 기능
git branch temp
git checkout temp

파일 설정

• .env 파일 설정
• content/ 경로 아래에 .env 만들기

CONTENT_TRANSLATED_ROOT=/[프로젝트파일경로]/translated-content/files
EDITOR=code

프로젝트 실행

# content 폴더 이동 후
yarn install
yarn start 

localhost:5042 열기

❗️Open in your editor 오류 발생 시

cmd + shift + p 누르고
Shell Command: Install 'code' command in PATH 입력