TeamRule
- 제목과 본문을 한 줄 띄워 분리해 주세요.
- 제목은 영문 기준 50자 이내로 적어주세요.
- 제목 첫글자를 대문자로 적어주세요.
- 제목 끝에
.는 금지합니다. - 제목은 명령어로 작성합니다.
- 본문은 50자마다 줄을 바꿔주세요.
- 본문은 어떻게 변경했는지 보다 무엇을 변경했는지, 왜 변경했는지 에 맞추어 작성하세요.
- 커밋 메세지 첫글자는 동사를 사용한다.(Fix, add, make, use, remove)
- semistandard 를 따릅니다.
주요 규칙
- space는 두 칸, 탭 사용 x
- 오직 single quote만 사용, 템플릿 리터럴은 표현식 사용할때만 사용하세요.
- var 는 사용하지 않습니다.
- 키워드 다음엔 스페이스 하나를 띄워주세요.
- 더 많은 정보는 https://standardjs.com/rules.html 를 참고하세요.
- 위 링크의 룰에서 오직 한 가지만 예외입니다. 세미 콜론 사용을 허용합니다.
| 종류 | 사용패턴 | 특징 |
|---|---|---|
| main | main | 프로덕션 스냅샷, 가장 최신의 배포된 버전 |
| dev | dev | 릴리즈 계획에 따라서 Github에서 기본 브랜치로 지정 |
| feature | feature/이슈번호-이름, feature/1-branch-name | dev에 병합 |
| hotfix | hotfix/이슈번호, hotfix/#911 | 메인에 병합 |
- 코드 컨벤션을 잘 지켜주세요. 컨벤션 오류로 인한 불필요한 코멘트는 시간 낭비이기 때문에 지양하는 것이 좋습니다.
- 리뷰 가이드라인을 잘 작성해 주세요. 모든 코드 변경사항에는 의도가 필요합니다. 의도치 않게 변경된 부분이 있다면 되돌려 놓아야 하고, 줄바꿈과 같이 아주 단순한 변경사항이라도 그 부분을 리뷰어가 볼 필요가 없다면 “Just line change” 와 같은 코멘트를 달아 명시하여 리뷰 시간을 줄여줄 수 있을 것입니다. 또는 사용된 라이브러리 업데이트가 포함되었다면 해당 라이브러리의 릴리즈 노트 링크나 스크린샷을 첨부하는 것도 좋은 방법입니다.
- 작업중, 리뷰 가능 여부를 잘 명시해 주세요. 아직 코드를 작성 중일 때에는 [WiP] (Work in Progress) 를 타이틀 앞에 추가하고, 만약 작업이 끝났으면 이를 제거하고 review-needed 태그를 설정할 수 있습니다. 한 번 작업을 마쳤다고 끝난 것이 아니기 때문에 리뷰를 반영하는 중에도 이 과정을 반복하여 명시해 주세요.
- PR 제목
[Client] / #88 / edit: readme
- PR 본문
- **아래 형식을 복사해 Github Pull Request 의 템플릿으로 지정 후 해당 본문은 삭제하시면 됩니다.
### PR 타입(하나 이상의 PR 타입을 선택해주세요)
-[] 기능 추가
-[] 기능 삭제
-[] 버그 수정
-[] 의존성, 환경 변수, 빌드 관련 코드 업데이트
### 반영 브랜치
ex) feat/login -> dev
### 변경 사항
ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.
### 테스트 결과
ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.
- Issue 제목
[title] / body
- 아래 형식을 복사해 Github Issue 의 템플릿으로 지정 후 해당 본문은 삭제하시면 됩니다.
### Issue 타입(하나 이상의 Issue 타입을 선택해주세요)
-[] 기능 추가
-[] 기능 삭제
-[] 버그 수정
-[] 의존성, 환경 변수, 빌드 관련 코드 업데이트
### 상세 내용
ex) Github 소셜 로그인 기능이 필요합니다.
### 예상 소요 시간
-[] `0.5h`
-[] `1h`
-[] `1.5h`
-[] `2h`
-[] `2.5h`
-[] `3h`
### 라벨
- 예상 소요 시간: `E: 1h`
- 그룹: `client`, `server`
- 긴급도: `High`, `Middle`, `Low`
- clientLogin
- ClientSide
- Node v16.13.0
- NPM 8.1.0