코드 컨벤션

프론트엔드

기본적으로 많이 사용되는 Airbnb React/JSX Style Guide 를 사용합니다.

하지만, 팀원분들의 역량을 고려해 일부 규칙은 완화하기로 했습니다.

백엔드

백엔드 역시 Aribnb JavaScript Style Guide를 사용합니다.

Branch

<branch-type>/#<issue-number>

​

• Branch type
  • feat : 기능 추가
  • fix : 오류 수정
  • refactor : 리팩토링
• main 브랜치는 배포용이다.
• 개발은 dev 를 중심으로 진행한다.
• 머지가 완료된 브랜치는 삭제한다.
• rebase merge 를 권장한다.

Commit

<commit type>: <description>

• Commit Type
  • docs : 문서 변경사항
  • feat : 새로운 기능
  • fix : 버그 수정
  • refactor : 기능 추가나 버그 수정이 아닌 변경 사항
  • style : 스타일 작성 또는 수정
  • test : 누락된 테스트 추가 또는 기존 테스트 수정
  • chore : 빌드 프로세스 업데이트, 패키지 매니저 설정 등의 변경사항

• Description
  • 한글로 작성한다.
    • 단, 클래스 이름, 컴포넌트 이름 등 필요한 경우 알파벳을 사용한다.
  • Body, Footer 가 필요하지 않을 정도로 간결하게 작성한다.

Labels

• FE / BE : 클라이언트/서버 작업 구분
• Feature : 새로운 기능을 추가
• BugFix : 문제 상황/오류 수정
• Refactor : 기능 추가, 오류 수정이 아닌 변경
• Docs : 문서 관련 작업
• Config : 환경설정, 기타 작업
• Test : 테스트 관련
• Question : 질문

Templates

기능 추가

## 세부 기능

[//]: # (이 백로그에서 구현할 세부 기능을 작성해주세요.)

- [ ] 구현할 세부 기능 1
- [ ] 구현할 세부 기능 2

## 완료 조건

[//]: # (이 백로그의 완료 혹은 종료 조건을 작성해주세요.)

- [ ] 완료 조건 1
- [ ] 완료 조건 2

## 참고 자료

[//]: # (참고할 문서, 디자인, API 문서 등을 첨부해주세요.)

- 참고 자료 1

버그 수정

## 버그 설명

[//]: # (어떤 버그가 발생했는지 설명을 작성해주세요.)

## 재현 방법

1. 어디를 가서
2. 무엇을 클릭했더니
3. 어떤 화면에서
4. 에러가 발생했다

## 정상 동작

[//]: # (원래 기대했던 동작을 설명해주세요.)

## 스크린샷

[//]: # (가능한 경우 스크린샷을 첨부해주세요.)

## 환경 정보

- OS:
- Browser:
- Version:

Pull Request

[//]: # (PR 제목은 [Feat] {제목} 형식으로 작성해주세요.)
[//]: # (Reviewer, Assignees, Labe을 붙여주세요.)

## 관련 이슈 번호

[//]: # (해당 PR이 어떤 이슈와 관련이 있는지 작성해주세요.)
[//]: # (ex. close #1, resolve #2)

## 작업 내용

[//]: # (해당 PR에서 어떤 작업을 했는지 작성해주세요.)

## 고민과 학습내용

[//]: # (해당 작업을 하면서 고민했던 점이나 학습한 내용을 작성해주세요.)
[//]: # (팀 노션의 학습로그와 연결해도 좋습니다.)

## 스크린샷

[//]: # (가능한 경우 스크린샷을 첨부해주세요.)