Skip to content

FrontEnd

krokerdile edited this page Jan 5, 2024 · 3 revisions

FE Wiki 페이지

커밋 컨벤션

태그

  • feat : 새로운 기능을 추가하는 경우
  • fix : 버그를 고치는 경우
  • style : 로직과 관련 없이 코드를 수정하는 경우
  • refactor : 로직과 관련하여 코드를 수정한 경우
  • comment : 주석을 추가/수정한 경우
  • docs : 문서를 추가/수정한 경우
  • test : 테스트를 추가/수정한 경우
  • chore : 프로덕션 코드에 변경이 없는 경우
  • rename : 파일/폴더를 수정한 경우
  • remove : 파일/폴더를 삭제한 경우

규칙

  1. 태그의 경우 소문자로 작성합니다.
  2. 태그와 콜론은 붙여 작성합니다.

제목

"추가", "수정", "변경" 과 같은 명령어로 시작합니다.

본문

어떻게 보다는 "무엇"을 그리고 "왜" 추가/수정 했는지에 관하여 작성합니다.

꼬리말

아래와 같은 규칙으로 이슈와 연관 시켜줍니다.

  • Resolves : #해결한이슈번호 (해결한 경우)
  • Related to: #해결중인이슈번호(해결 중인 경우)
  • Ref : #참고한이슈번호 (optional)
좋은 git 커밋 메시지 작성을 위한 7가지 약속

1. 제목과 본문을 한 줄 띄워 분리하기
2. 제목은 영문 기준 50자 이내로
3. 제목 첫글자를 대문자로
4. 제목 끝에 . 금지
5. 제목은 명령조로
6. 본문은 영문 기준 72자마다 줄 바꾸기
7. 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

출처 : https://meetup.nhncloud.com/posts/106

PR 컨벤션

제목

[FE/#티켓이슈번호] 태그: 티켓 제목 형식으로 제목을 작성합니다.

본문

🎫 연관 티켓 
---
#연관티켓이슈번호

🙏 작업
----
- 작업1
- 작업2

💁‍♂️ 어떻게?
----
- 작업1 어떻게?
- 작업2 어떻게?

🙈 PR 참고 사항
----
- 질문?
- 추가 티켓

📸 스크린샷
----

🤖 테스트 체크리스트
----
- [ ] 체크 미완료
- [x] 체크 완료

규칙

  • Development에서 티켓과 연결해주세요.
  • 담당자 설정을 합니다.
  • 리뷰어를 설정합니다.
    • 리뷰어는 2일 이내로 리뷰를 진행합니다.
    • 리뷰어의 리뷰를 반영하였을 때는 해당 커밋 id를 남겨 반영사항을 확인할 수 있도록 합니다.

Branch 전략

FE 팀의 branch는 fe를 prefix로 가진다.

기본적인 branch는 아래와 같습니다.

  • fe
    • dev
    • #티켓번호-간단설명영어로

공통 branch로 merge되는 FE 팀의 branch는 fe/dev branch 입니다.

Clone this wiki locally