TIL

프로젝트 회고 2 :: 기능부터 컨벤션까지 정해야 할게 너무 많아요.

Deeb 2022. 7. 6. 22:46

팀 깃헙을 만들었다면 이제부터 정해야하는 것들의 연속이다.

커밋 컨벤션은 어떻게 할 것인가?
issue 컨벤션은 어떻게 할 것인가?
협업툴은 어떤것을 쓸 것인가? - 슬랙, 디스코드, 카톡, 트렐로, 노션, 깃허브 프로젝트
pr 컨벤션은 어떻게 할 것인가?
브랜치 전략은 어떤것을 쓸 것인가?- git-flow? github-flow?

우리팀이 정한 컨벤션을 정리해보았다.

컨벤션

변수 이름

  • 변수: ‘명사형'으로 작성. 무엇을 담고있는지 정확히 표현(예: numberOfPeople)
  • 함수 : ‘동사형'으로 작성. 무엇을 하는 함수인지 정확히 표현(예: getInputValue){용도}-{기능명} : product-img, login-input
  • HTML/CSS : 케밥, JS : 카멜

커밋 컨벤션

### 제목
# [커밋 타입] 작업내용 (제목과 본문은 한 줄 띄워주세요)

### 본문 - 한 줄에 최대 72 글자까지만 입력하기  
# 무엇을, 왜, 어떻게 했는지

# 꼬리말
# 이슈번호 작성
resolves: #이슈번호

#   [커밋 타입]  리스트
#   Add       : 파일 또는 기능 (새로운 기능) 추가
#   Update    : 기능 수정
#   Delete    : 파일 또는 기능 삭제
#   Fix       : 버그 (버그 수정)
#   Design    : CSS 등 사용자 UI 디자인 변경
#   Docs      : 문서 (문서 추가, 수정, 삭제)
#   Rename    : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 하는 경우
#   Remove    : 파일을 삭제하는 작업만 수행한 경우
#   Chore     : 기타 변경사항 (빌드 스크립트 수정 등)
# ------------------
#   [체크리스트]
#     제목 첫 글자는 대문자로 작성했나요?
#     제목은 명령문으로 작성했나요?
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분했나요?
# ------------------

github pr 컨벤션

### 무엇을 위한 PR인가요?(: 뒤 설명추가)

- [x] 신규 기능 추가 :
- [ ] 기능 수정 :
- [ ] 버그 수정 :
- [ ] 기타 : 

### 변경사항 및 이유

- 이유

### 작업 내역

- 작업 내역 

### 작업 후 기대 동작(스크린샷)

- 동작 

### PR 특이 사항

- 특이 사항

### Issue Number 

close: #

### 어떤 부분에 리뷰어가 집중하면 좋을까요?

<!-- 좋은 pr 체크리스트 -->

<!-- 
- 무슨 이유로 코드를 변경했는지
- 어떤 위험이나 장애가 발견되었는지
- 어떤 부분에 리뷰어가 집중하면 좋을지
- 관련 스크린샷
- 테스트 계획 또는 완료 사항
-->

브랜치 전략 - 깃 플로우


ui 작업에 앞서 우선 순위 정하기

1. 주어진 디자인에서 사용자 경험측면을 높이기 위해

회원가입에서 안내문구가 아닌 아예 고정으로 뜨게해서 입력할 때 마다 확인할 수 있는 디자인으로 변경하였다.


2. 상품판매 링크로 넘어가게 하는 기능에서

우리는 전문 판매업자가 아닌 개인간의 소통이기에 모달창으로 별도로 추가하는 식으로 변경했다.

회의한 내용은 아니었지만 들었던 얘기 중 프로젝트를 진행할 때 고민해보면 좋은 질문이 있어 적어보았다.


1. sw의 목적이 무엇인가?

'사용자의 문제해결을 위한것이다' 라고 해주셨는데

이 말을 듣고나니 이 기능 저 기능 추가하고싶고 디자인도 더 바꾸고싶다가도 기능과 구현에 더 초점을 맞추게 되었다.

 

반응형