현주팀 FE 최종 프로젝트 컨벤션

🛠️기술 스택

🚀코딩 컨벤션

📌 코딩 스타일

📌코드 네이밍

📌브랜치 구조 및 네이밍

• feature - 개별 feature 구현 브랜치

• dev - feature 통합 브랜치

• release - 프로덕트 배포전 테스트 배포 브랜치

• main - 프로덕트 배포 브랜치
💡
prefix/keyword/<이슈번호> → feature/button/#1

📌파일, 폴더 구조 및 네이밍

src 
  assets
  components
    공용 
  types
  styles
  lib
    constants
    hooks
    stores
    utils
    api
app
  page
    layout.tsx 
    components
    sections <- view 가 비대해지면 짜른다.
    Page.model.tsx
    Page.controller.tsx   
    Page.view.tsx   
    Page.styles.ts
    page.tsx <- controller

📌디자인 패턴

📌스타일 네이밍

1. 컴포넌트 단위
1. 컴포넌트명 + 스타일명
2. ex) PostCardContentText, PostCardContainer

📌브랜치 구조 및 Merge 규칙

PR 템플릿

* 이슈 링크: 

## 💡 핵심적으로 구현된 사항
<-- 문제를 해결하면서 주요하게 변경된 사항들을 "스크린샷"과 함께 적어 주세요 -->
*

## ➕ 그 외에 추가적으로 작업한 사항
<-- 주 Task 이외의 작업한 변경 사항  -->
*

## 🤔 테스트,검증 && 고민 사항
<-- 배포에서 체크해봐야 할 부분 -->
<-- 궁금한 점, 팀원들의 의견이 필요한 부분, 크로스체크가 필요한 부분 등 -->
*

## PR 반영사항
<-- PR 요청 사항을 리스트로 표시하고 반영 여부를 표시합니다 -->
*

Issue 템플릿

# 구현 주제 ex) 회원가입 페이지와 회원가입 단계를 구현합니다.
---

## Task List
- [ ] SignUp Page 구현
   - [ ] Section 간의 transition 구현 
   - [ ] 닉네임 입력 Section 구현
   - [ ] 추가정보 입력 Section 구현
   - [ ] 약관 Section 구현

📌코드 리뷰 룰

작은 PR 규칙뱅크샐러드의 코드 리뷰 문화가 성숙해지기 전에는 PR의 코드 라인 수에 대한 규칙이 없었습니다. 개발하는 기능의 복잡도에 따라 짧게는 코드는 수백 줄, 많게는 10,000줄 이상의 PR 이 만들어지기도 했습니다. 코드의 길이가 길어질수록 리뷰어의 집중도는 떨어질 수밖에 없었습니다. 코드를 이해하는 시간이 길어지고, 리뷰는 목표한 일정에 완료되지 못하고, 병목이 되기 시작했습니다. 코드 리뷰가 고객 임팩트를 내는 부분에 있어서 병목이 되지 않도록 ‘작은 PR 규칙’ (1개의 PR은 1,000 Line을 넘을 수 없다“) 을 정했습니다.‘작은 PR 규칙’ 도입 초기에는 “복잡한 기능을 만드는데 1,000줄은 너무 적은 것 아닌가?“, “테스트 코드도 라인 수에 포함해야 하는가?” 등의 원칙에 대한 의문과, 여러 개의 PR을 만들어야 하는 부분이 오히려 생산성을 떨어트리지 않을까 하는 우려도 있었지만, 이후 몇 차례의 코드 리뷰를 진행하면서 규칙을 구체화해 나가고 노하우도 쌓이기 시작했습니다. - PullRequest, Commit의 단위는 최소의 기능 단위로 세분화한다. - 테스트 코드는 Mock json 이 라인 수의 대부분을 차지하므로 제한을 두지 않는다. 코드 리뷰 문화가 성숙해가면서 우리는 리뷰 병목 해소와 조직의 확장성을 얻을 수 있었습니다. 모든 PR은 200 ~ 300줄 내외가 되고 1~2일 이내에 리뷰를 완료하여 리뷰의 병목을 해소할 수 있었습니다. 서비스의 성장과 함께 iOS 챕터의 구성원도 4명에서 8명으로 늘어났고, 개발되는 코드의 양(= PR의 양) 도 증가했지만 ‘작은 PR 규칙’ 아래 병목 없는 성장

• P4 ~ P5 사항의 경우 반영 여부를 slack 에 고지한 후 merge 진행 하는 것을 지향합니다.

📌커밋 룰