Skip to content

팀 규칙

hyejung kim edited this page Nov 13, 2021 · 4 revisions

Git Convention

Commit Message

[category] 변경사항 요약 [feat] 홈화면 폴더 가로스크롤 구현

category description
feat 기능 추가
add 코드 추가
delete 코드 삭제
mod 코드 수정
fix 버그 수정
chore 동작에 영향을 주지 않는 변경 사항
refactor 리팩토링

Branch Name

branchName-변경 사항

ex. main-home-folder : home 화면 중 folder 작업을 진행한다.

main이 기본 메인 브랜치

|
main
| \
|  main-home-folder

Merge

  1. 개인이 작업한 브랜치를 원격 저장소에 push한 후 PR 보내기
  2. 필요시 다른 팀원에게 PR요청, PR받은 팀원은 코드에 대한 리뷰를 작성
  3. 팀원이 수정을 요청하면 로컬에서 수정 후 다시 push (수정 완료 슬랙에 공지)
  4. 각자 merge (단, 다른 팀원이 수정을 요청한 경우, merge 동의를 받아야 함)

Development Process

  1. issue 생성
  2. issue 기반 branch 생성
  3. issue와 관련된 feature 개발 완료
  4. PR이 main branch로 merge
  5. merge 후 feature branch 제거
  6. issue close

Code Convention

  1. 함수명은 Camel Case 사용, db와 접근하는 변수명은 Snake Case 사용
  2. Reformat Code로 코드 정리
  3. 중요하고, 해결해야 할 or 해결하지 못했지만 중요한 문제의 경우 //@TODO로 주석 작성
  4. 함수에 대해 설명이 필요할 경우 //@param로 주석 작성