Skip to content

Commit 8013b8c

Browse files
committed
fix: improve clarity and consistency in README.md
문장이 어색한 부분 및 미번역된 일부 문장들 번역하여 반영하였습니다.
1 parent 6f41a9b commit 8013b8c

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,73 @@
11
# ko.react.dev
22

3-
[![](https://dcbadge.vercel.app/api/server/YXdTyCh5KF)](https://discord.gg/YXdTyCh5KF)
3+
[![React Korea 디스코드 채널](https://dcbadge.vercel.app/api/server/YXdTyCh5KF)](https://discord.gg/YXdTyCh5KF)
44

55
## 한국어 번역 정보
66

77
### 가이드
88

9-
번역을 진행할 때에 다음의 가이드를 따라주세요.
9+
번역 혹은 기여를 진행할 때, 아래 가이드를 따라주세요.
1010

11-
1. 다음과 같은 [공통 스타일 가이드 확인 (Check the common style guide)](/wiki/universal-style-guide.md) 따르고 있습니다.
12-
2. [모범 사례 확인 (Check best practices)](/wiki/best-practices-for-translation.md) 따라주세요.
13-
3. 공통된 단어 번역을 위해 [용어 확인 (Check the term)](/wiki/translate-glossary.md) 참고해주세요.
14-
4. 끌어오기(Pull Request) 요청 시 테스트를 통과하지 못할 경우 [Textlint 가이드 확인 (Check the textlint guide)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/textlint/what-is-textlint.md) 참고해주세요.
15-
5. 마지막으로 [맞춤법 검사 (Spelling check)](https://nara-speller.co.kr/speller/)를 진행해주세요.
11+
1. [공통 스타일 가이드<sup>Universal Style Guide</sup>](/wiki/universal-style-guide.md) 따르고 있습니다.
12+
2. [번역을 위한 모범 사례<sup>Best Practices for Translation</sup>](/wiki/best-practices-for-translation.md) 따라주세요.
13+
3. 공통된 단어 번역을 위해 [번역 용어 정리<sup>Translate Glossary</sup>](/wiki/translate-glossary.md) 참고해주세요.
14+
4. 끌어오기 요청<sup>Pull Request</sup>시 테스트를 통과하지 못할 경우, [`textlint` 가이드<sup>What is Textlint</sup>](/wiki/textlint/what-is-textlint.md) 참고해주세요.
15+
5. 마지막으로 [맞춤법 검사<sup>Spelling Check</sup>](https://nara-speller.co.kr/speller/)를 진행해주세요.
1616

17-
저장소는 [ko.react.dev](https://ko.react.dev/)의 소스 코드와 개발 문서를 포함하고 있습니다.
17+
저장소<sup>Repository</sup>는 [ko.react.dev](https://ko.react.dev/)의 소스 코드와 개발 문서를 포함하고 있습니다.
1818

1919
## 시작하기
2020

2121
### 사전 준비
2222

2323
1. Git
2424
1. Node: v16.8.0 이상의 모든 버전
25-
1. Yarn v1: [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/) 참고
26-
1. 포크한 개인 저장소
27-
1. 로컬에 클론(Clone)[ko.react.dev repo](https://github.com/reactjs/ko.react.dev) 개인 저장소
25+
1. Yarn v1(`[email protected]`): [Yarn 설치 안내](https://yarnpkg.com/lang/en/docs/install/) 참고
26+
1. 포크<sup>Fork</sup>한 개인 저장소
27+
1. 로컬에 클론<sup>Clone</sup>[ko.react.dev 저장소](https://github.com/reactjs/ko.react.dev)
2828

2929
### 설치
3030

3131
1. `cd ko.react.dev`를 실행하여 프로젝트 경로로 이동합니다.
32-
1. `yarn` 을 이용하여 npm 의존성 모듈들을 설치합니다.
32+
1. `yarn` 명령어를 실행하여 npm 의존성 모듈들을 설치합니다.
3333

3434
### 개발 서버 실행하기
3535

36-
1. `yarn dev` 명령어를 사용하여 hot-reloading 개발 서버를 시작합니다. (powered by [Next.js](https://nextjs.org))
36+
1. `yarn dev` 명령어를 사용하여 개발 서버를 시작합니다. (powered by [Next.js](https://nextjs.org))
3737
1. `open http://localhost:3000` 명령어를 사용하여 선호하는 브라우저로 접속하세요.
3838

3939
## 기여 방법
4040

4141
### 가이드라인
4242

43-
이 문서는 목적이 다른 여러 섹션으로 나뉘게 됩니다. 문장을 추가할 계획이라면, 적절한 섹션에 대한 [contributing guidelines](/CONTRIBUTING.md)을 숙지하는 것이 도움이 될 것입니다.
43+
이 문서는 목적이 다른 여러 섹션으로 나뉩니다. 문장을 추가할 계획이라면, 적절한 섹션에 대한 [기여 가이드라인<sup>Contributing Guidelines</sup>](/CONTRIBUTING.md)을 숙지하는 것이 도움이 될 것입니다.
4444

45-
### 브랜치(branch) 만들기
45+
### 분기<sup>Branch</sup> 만들기
4646

4747
1. `ko.react.dev` 로컬 저장소에서 `git checkout main`을 실행합니다.
48-
1. `git pull origin main` 실행하여 최신 원본 코드를 보장할 수 있습니다.
49-
1. `git checkout -b the-name-of-my-branch` (`the-name-of-my-branch` 를 적절한 이름으로 교체)를 실행하여 브랜치를 만듭니다.
48+
1. `git pull origin main` 실행하여 최신 코드를 가져올 수 있습니다.
49+
1. `git checkout -b the-name-of-my-branch`를 실행하여 분기<sup>Branch</sup>를 만듭니다. (이때, `the-name-of-my-branch`를 적절한 이름으로 교체.)
5050

5151
### 수정하기
5252

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

59-
### 수정사항 체크하기
59+
### 수정사항 검사하기
6060

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

64-
### Push 하기
64+
### 푸시<sup>Push</sup> 하기
6565

66-
1. `git add -A && git commit -m "My message"` (`My message` 부분을 `Fix header logo on Android` 같은 커밋 메시지로 교체)를 실행하여 변경한 파일들을 commit 해주세요.
66+
1. `git add -A && git commit -m "My message"`를 실행하여 변경한 파일들을 커밋<sup>commit</sup> 해주세요. (이때, `My message` 부분을 `Fix header logo on Android` 같은 커밋 메시지로 교체.)
6767
1. `git push my-fork-name the-name-of-my-branch`
68-
1. [ko.react.dev repo](https://github.com/reactjs/ko.react.dev)에서 최근에 푸시된 브랜치를 볼 수 있습니다.
69-
1. GitHub 지침을 따라주세요.
70-
1. 가능하다면 시각적으로 변화된 부분의 스크린샷을 첨부해주세요. PR을 만들고 다른사람들이 수정사항을 볼 수 있게되면 자동으로 빌드할 것입니다.
68+
1. [ko.react.dev 저장소](https://github.com/reactjs/ko.react.dev)에서 최근에 푸시된 분기<sup>Branch</sup>를 볼 수 있습니다.
69+
1. 깃허브<sup>GitHub</sup> 지침을 따라주세요.
70+
1. 가능하다면 시각적으로 변화된 부분의 스크린샷을 첨부해주세요. 변경 사항이 깃허브<sup>GitHub</sup>에 푸시<sup>Push</sup>되면 미리보기 빌드가 트리거됩니다.
7171

7272
## 문제 해결하기
7373

@@ -77,7 +77,7 @@
7777

7878
`react.dev` 번역에 흥미가 있다면, [translations.react.dev](https://translations.react.dev/)에서 현재 번역이 얼마나 진행되었는지 확인해주세요.
7979

80-
번역하려는 언어가 아직 진행되지 않았다면, 해당 언어에 대해 새롭게 만들 수 있습니다. [translations.react.dev repo](https://github.com/reactjs/translations.react.dev)를 참고해주세요.
80+
번역하려는 언어가 아직 진행되지 않았다면, 해당 언어에 대해 새롭게 만들 수 있습니다. [translations.react.dev 저장소](https://github.com/reactjs/translations.react.dev)를 참고해주세요.
8181

8282
## 저작권
8383

0 commit comments

Comments
 (0)