[개발] 코딩 컨벤션

Git 컨벤션

Git flow

 

💡 COMMIT 컨벤션

‘jira이슈번호 + [type] + 페이지명 + 내용(기능)’

ex) git commit -m "S08P12B302-22 [Modify] 페이지 기능”

수정 - Modify
구현 - Add
삭제 - Delete

 

Front-end 컨벤션

저희 팀은 Airbnb Eslint를 사용하기로 했습니다 ! (최대한 따르며 코딩 실력을 늘리기로 결정 !!!)

주석

• 여러 줄에 걸친 주석을 쓸 때는 /** ... */ 사용

/**
 * make()는 전달된 태그명을 기반으로
 * 새로운 요소를 반환한다.
 */
function make(tag) {

  // ...

  return element;
}

• 한줄 주석을 쓸 때는 // 사용

// is current tab
const active = true;

• 주석 전에는 빈 행 삽입
• 모든 주석은 공백으로 시작 eslint: spaced-comment
• 문제를 지적하고 재고를 촉구하는 경우나 문제의 해결책을 제안하는 경우 등에는 주석 앞에 FIXME 나 TODO 를 붙임
  • 문제에 대한 주석으로 // FIXME: 를 사용

  class Calculator extends Abacus {
    constructor() {
      super();
  
      // FIXME: 전역 변수를 사용해서는 안 됨
      total = 0;
    }
  }
  

  • 문제의 해결책에 대한 주석으로 // TODO: 를 사용

  class Calculator extends Abacus {
    constructor() {
      super();
  
      // TODO: total은 옵션 파라메터로 설정해야함
      this.total = 0;
    }
  }