diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5381f3e5..a0e558bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,7 +14,7 @@ TODO: Add support수정 필요! 로컬 기기에 [clone](https://help.github.com/articles/cloning-a-repository/) 합니다. 2. VSCode를 사용한다면 아래 과정을 통해 custom TS setting을 활성화해야합니다. - 1. TypeScript 파일이 열러있는 상태로 `ctrl(cmd) + shift + p`를 입력합니다. + 1. TypeScript 파일이 열려 있는 상태로 `ctrl(cmd) + shift + p`를 입력합니다. 2. "Select TypeScript Version"을 선택합니다. 3. "Use Workspace Version"을 선택합니다. @@ -32,7 +32,7 @@ TODO: Add support수정 필요! ```shell yarn serve ``` -6. 그 외 여러가지 명령어들을 사용해볼 수 있습니다. +6. 그 외 여러 가지 명령어들을 사용해 볼 수 있습니다. ```shell # 빌드 @@ -42,7 +42,7 @@ TODO: Add support수정 필요! yarn test ``` -7. [demo README](https://github.com/EveryAnalytics/react-analytics-provider/tree/main/demo)를 참고해 demo앱도 실행해보세요. +7. [demo README](https://github.com/EveryAnalytics/react-analytics-provider/tree/main/demo)를 참고해 demo앱도 실행해 보세요. ## Debugging @@ -60,7 +60,7 @@ TODO: Add support수정 필요! ## Commit message -커밋 메세지는 제목과 본문을 포함해야합니다. +커밋 메세지는 제목과 본문을 포함해야 합니다. 제목은 해당 커밋에 대한 주요 내용을 간략하게 기록합니다. 형식은 https://www.conventionalcommits.org/en/v1.0.0/ 를 따릅니다. @@ -74,21 +74,21 @@ TODO: Add support수정 필요! ## Issue -- 각 이슈는 1개의 주제만 포함해야합니다. -- 문제상황이나 제안을 포함해주세요. -- 최대한 구체적이고 명확하게 작성해주세요. \*필요에 따라 스크린샷도 첨부해주세요. +- 각 이슈는 1개의 주제만 포함해야 합니다. +- 문제상황이나 제안을 포함해 주세요. +- 최대한 구체적이고 명확하게 작성해 주세요. \*필요에 따라 스크린샷도 첨부해 주세요. ## Pull request(PR) `main` 브랜치에 PR을 열어주세요. -각 PR은 1개의 주제만 포함해야합니다. 1개의 주제는 여러 부분의 코드를 수정할 수도 있습니다. 예를 들어, `새로운 ga 연동 함수를 추가`는 라이브러리 구현, demo에 예시 추가, 문서 내용 추가 등을 포함합니다. +각 PR은 1개의 주제만 포함해야 합니다. 1개의 주제는 여러 부분의 코드를 수정할 수도 있습니다. 예를 들어, `새로운 ga 연동 함수를 추가`는 라이브러리 구현, demo에 예시 추가, 문서 내용 추가 등을 포함합니다. PR의 제목 형식은 commit과 동일하게 맞추면 됩니다. ## Coding Guidelines -`vscode`의 `eslint` 플러그인을 통해 미리 설정된 코드 컨벤션을 적용하고 검사해볼 수 있습니다. +`vscode`의 `eslint` 플러그인을 통해 미리 설정된 코드 컨벤션을 적용하고 검사해 볼 수 있습니다. ## Add yourself as a contributor