Skip to content

Team Rule

Ellie-kang edited this page Oct 27, 2022 · 3 revisions

타코야끼 규칙

Discord 규칙

꾸준한 소통 필수!

  • 매일 미팅
    • 오전 10시 하루 계획 짧게 git Issues [daily]
    • 오전 10시 ~ 오후 6시 라운지 채널
    • 오후 1시 짧은 디스코드 미팅 (팀장 머지)
  • 태도 점검
    • 욕하지 않기
    • 짜증내지 않기
    • 포기하지 않기

커밋 메시지 규칙

커밋 메시지는 제목과 본문으로 나누어 집니다. 한 줄만 작성해도 설명이 충분하다면 제목만으로도 괜찮습니다. 하지만 어떤 변경 사항이 있는지 맥락과 설명이 필요하다면 본문을 작성할 수 있습니다. 다음은 제목과 본문을 작성하는 규칙입니다.

  1. 커밋 메시지는 본문 없이 제목만 간단히 적어주세요.
  2. 제목은 영문 기준 50자 이내로 적어주세요.
  3. 커밋 메시지는 항상 소문자로 적어주세요.
  4. 제목 끝에 . 는 금지합니다.
  5. 제목은 아래 명령 리스트에 맞추어 적어주세요.

커밋 메시지 명령리스트

  • build : build system이나 외부의존성 npm 등에 변경이 있을때
  • ci : CI configuration files 와 script에 변경이 생겼을때
  • docs : documentation에만 변경이 생겼을때
  • feat : new feature 이 생겼을때 (새 기능이 생겼을 때)
  • fix : bug fix 됬을때
  • perf : 코드의 퍼포먼스가 높아졌을때
  • refactor : fix 나 feat이 아닌데 리팩토링으로 코드를 수정했을때
  • style : while-space, formatting, missing semi-colnes 등 코드의 의미에 영향을 미치지 않는 변화가 생겼을때
  • test : 누락된 테스트를 추가하거나 기존의 테스트를 correcting 하는것

git commit -m ‘fix : some error fixed’

Lint 규칙

따로 package manager은 사용하지 않겠습니다. 추후에 변경될수있음.

주요 규칙

  • 오직 single quote만 사용, 템플릿 리터럴은 표현식 사용할때만 사용하세요.
  • var 는 사용하지 않습니다.
  • 키워드 다음엔 스페이스 하나를 띄워주세요.
  • function 생성할때 가급적이면 화살표함수로 작성하는것을 지향해주세요.
  • 세미콜론은 항상 붙혀주세요.

PR 형식

  • 코드 컨벤션 잘 지키기.

  • 리뷰 가이드라인 작성, 아주 단순한 변경사항이라도, 그 부분을 볼 필요가 없다면 코멘트를 남겨 리뷰 시간을 줄여주세요.

  • 작업중, 리뷰 가능 여부를 잘 명시해 주세요. 코드 작성중일 때에는 [WIP] Work In Progress 같은 타이틀을 추가.

  • pr 제목

[client] / #number / edit: readme
  • pr 본문

### PR 타입(하나 이상의 PR 타입을 선택해주세요)
- [ ] 기능 추가
- [ ] 기능 삭제
- [ ] 버그 수정
- [ ] 의존성, 환경 변수, 빌드 관련 코드 업데이트

### 반영 브랜치
ex) feature/login -> dev

### 변경 사항
ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다.

### 테스트 결과
ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.

Issue 형식

  • Issue 제목
[title] / body
  • 아래 형식을 복사해 Github Issue 의 템플릿으로 지정 후 본문은 삭제하면됨.

### Issue 타입(하나 이상의 Issue 타입을 선택해주세요)
- [ ] 기능 추가
- [ ] 기능 삭제
- [ ] 버그 수정
- [ ] 의존성, 환경 변수, 빌드 관련 코드 업데이트

### 상세 내용
ex) Github 소셜 로그인 기능이 필요합니다.

### 라벨
- 그룹: `client`, `server`

변수이름 -Camel-case

  • const a = clientSide;

파일 생성자 이름

  • LandingPage