/ko.reactjs.org

(Work in progress) React documentation website in Korean

Primary LanguageTypeScriptCreative Commons Attribution 4.0 InternationalCC-BY-4.0

reactjs.org

이 저장소는 reactjs.org의 소스 코드와 개발 문서를 포함하고 있습니다.

시작하기

사전 준비

  1. Git
  2. Node: 12.0.0 이상으로 시작하는 모든 12.x 버전
  3. Yarn v1: Yarn website for installation instructions 참고
  4. 포크한 개인 저장소
  5. 로컬에 클론(Clone) 한 reactjs.org repo 개인 저장소

설치

  1. cd reactjs.org를 실행하여 프로젝트 경로로 이동합니다.
  2. yarn을 이용하여 npm 의존성 모듈들을 설치합니다.

개발 서버 실행하기

  1. yarn dev 명령어를 사용하여 hot-reloading 개발 서버를 시작합니다. (powered by Gatsby)
  2. open http://localhost:8000 명령어를 사용하여 선호하는 브라우저로 접속하세요.

기여방법

가이드라인

이 문서는 목적이 다른 여러 섹션으로 나뉘게 됩니다. 문장을 추가할 계획이라면, 적절한 섹션에 대한 가이드라인을 숙지하는 것이 도움이 될 것입니다.

브랜치(branch) 만들기

  1. reactjs.org 로컬 저장소에서 git checkout main를 실행합니다.
  2. git pull origin main를 실행하여 최신 원본 코드를 보장할 수 있습니다.
  3. git checkout -b the-name-of-my-branch (the-name-of-my-branch 를 적절한 이름으로 교체)를 실행하여 브랜치를 만듭니다.

수정하기

  1. "개발 서버 실행하기" 부분을 따릅니다.
  2. 파일을 저장하고 브라우저에서 확인합니다. 1.src안에 있는 React 컴포넌트가 수정될 경우 hot-reload가 적용됩니다.
    1. content안에 있는 마크다운 파일이 수정될 경우 hot-reload가 적용됩니다.
    2. 플러그인을 사용하는 경우, .cache 디렉토리를 제거한 후 서버를 재시작해야 합니다.

수정사항 체크하기

  1. 가능하다면, 변경한 부분에 대해서 많이 사용하는 브라우저의 최신 버전에서 시각적으로 제대로 적용되었는지 확인해주세요. (데스크탑과 모바일 모두)
  2. 프로젝트 루트에서 yarn check-all를 실행합니다. (이 명령어는 Prettier, ESLint, 그리고 Flow를 실행합니다.)

Push 하기

  1. git add -A && git commit -m "My message" (My message 부분을 Fix header logo on Android 같은 커밋 메시지로 교체)를 실행하여 변경한 파일들을 commit 해주세요.
  2. reactjs.org repo에서 최근에 푸시된 브랜치를 볼 수 있습니다.
  3. Github 지침을 따라주세요.
  4. 가능하다면 시각적으로 변화된 부분의 스크린샷을 첨부해주세요. PR을 만들고 다른사람들이 수정사항을 볼 수 있게되면 자동으로 빌드할 것입니다.

번역

reactjs.org 번역에 흥미가 있다면, translations.reactjs.org에서 현재 번역이 얼마나 진행되었는지 확인해주세요.

번역하려는 언어가 아직 진행되지 않았다면, 해당 언어에 대해 새롭게 만들 수 있습니다. reactjs.org Translations를 참고해주세요.

문제 해결하기

  • yarn reset 명령어를 사용하여 로컬 캐시를 초기화합니다.

저작권

위 내용에 대한 저작권은 reactjs.org가 가지고 있으며, LICENSE-DOCS.md에서 볼 수 있는 CC-BY-4.0 라이센스를 따릅니다.