Skip to content

Coding Convention & Git Workflow

ttoru96 edited this page Oct 26, 2019 · 1 revision

Indentation

prettier indent: 4
editor indent: 4

Naming

클래스: 대문자로 시작, camel case 
클래스 파일명(.js, .css)는 대문자로 시작, camel case
클래스 파일 제외한 파일명는 소문자로 시작하는 camel case
함수: 소문자로 시작하는 camel case
상수: 전부 대문자, 언더바로 구분. 
변수: 소문자. 언더바로 구분.  

JSX: BEM

  1. selector는 전부 소문자로 작성, '-'로 구분.
  1. child element 없는 JSX component 콜할 때는 self-closing tag를 씁니다.

< TodoList />

Comment

  1. 클래스 위에 헤더 코멘트 달아야 합니다.
  2. 본인이 볼 목적으로 todo를 적을 때만 코드 옆에 적습니다.

class Article { // TODO:

  1. 나머지 경우에는 코드 위에 적습니다.

/* 주석 */

function() => { 이렇게 }

Curly Bracket

if (condition) { code; }

Trailing Comma

Use it all the time

Git Branch Naming Convention

feature/some-new-feature (feature/implement-login-page)
refactor/change-code-to-new-pattern (refactor/fixed-store-structure)
bugfix/login-not-working-or-something (bugfix/login-logout-error)
hotfix/typo-or-style-issue (hotfix/fixed-me-being-an-idiot)

Git workflow

  1. 해결하고자 하는 문제(기능 개발 / 버그 픽스 등등)을 이슈에 올린다
  2. 이슈에 대한 답글로 누가 해결할 건지(A) assign한다.
  3. A는 브랜치를 판다 (깃 브랜치 네이밍 컨벤션 엄수합시다)
  4. 개발이 끝나면 PR을 날린다 (빠른 확인을 위해 카톡으로도 한 번 말해주세용)
  5. 커밋메시지 작성:
    #[issue no]: 뭔가 했다 #Issue 34: Implemented wardrobe page
  6. 코드리뷰를 한다
  7. 코드리뷰 결과 확인하고 필요하면 수정한 다음(c-f 반복) 개발한 본인이 머지한다
  8. 이슈를 close한다! (짠!)