[in process]Project Convention Rules

[argon1025]

#3

들어가기 전

추가 해야할 프로젝트 컨벤션이 존재할 경우 -> 이슈로 생성
수정 해야할 프로젝트 컨벤션이 존재할 경우 -> 이곳 코맨트로 작성

TOC

• 패키지 관리
  • 패키지 매니저 컨벤션
  • 패키지 설치 컨벤션
  • 패키지 파일 접근 컨벤션
• ESLint rule
• Git 형상관리, 협업
  • flow 컨벤션
  • 커밋 메시지 컨벤션
  • Merge 컨벤션
  • 이슈 트래커
• 코드 리뷰 컨벤션
• 코드 컨벤션

---

패키지 관리

이 섹션에서는 패키지 관리 규칙에 대해서 다룹니다

패키지 매니저

yarn을 사용합니다.

패키지 설치

1. 패키지를 설치할 때 반드시 지정된 패키지 매니저 명령어를 사용해야 합니다
2. 패키지 설치작업은 단일 커밋으로 분리해야합니다
3. PeerDependencies warn가 발생 할 경우 다음과 같은 원칙을 따릅니다
   3-1. PeerDependencies 패키지가 이미 설치 되어 있는지 확인합니다
   3-2. 메이저 업데이트를 제외한 업데이트가 필요할 시 업데이트합니다
   3-3. 작업을 PR에 명시합니다

peerDependencies란 실제로 패키지에서 require나 import 하지는 않지만, 특정 라이브러리나 툴에 호환성을 필요로 할 경우에 명시하는 dependencies입니다.

패키지 파일 접근

1. Package.json, yarn.lock 파일은 절대 본인이 직접 수정하지 않습니다.
2. 필요할 경우 지정된 패키지 관리자 명령어를 통해서 수정, 접근 하셔야 합니다

ESLint Rule

Airbnb-TypeScript Rule을 준수합니다

Git 형상관리, 협업

GitFlow

• Master(Main)
  • 메인 작업 브랜치
• Per-production
  • 배포전 스테이징 브랜지
  • Delploy만 가능 합니다.
• Production
  • 배포 브랜치
  • Deploy만 가능 합니다.

Commmit message

Conventional Commits을 준수합니다

Merge 히스토리

Squash and Merge ( Linear History )를 준수합니다

이슈 트래킹

git Projects를 사용합니다
이슈를 생성 및 관리하는 방법은 아래와 같습니다.

이슈 생성하기

이슈에서 작업을 생성합니다. 이슈를 생성할 경우 Github Projects에 자동으로 추가됩니다

작업중인 이슈 표현하기

담당 칸반에서 이슈 아이템을 `⚙️ | In Progress`로 이동시켜서 작업 여부를 표시합니다

이후 이슈가 종료되거나, PR이 Merge될 경우엔 자동으로 칸반 📍 | Done으로 이동됩니다

PR 컨벤션

• 빠른 시간 내에 검토할 수 있도록 충분한 정보를 제공해야 합니다
• 다른 개발자가 쉽게 읽을 수 있어야 합니다
• 하나의 PR은 하나의 단위 기능만 개발해야 합니다
• PR요청에는 200줄 이상의 코드가 변경되어서는 안 됩니다

PR 규정에 대한 근거로 다음 문서를 참고했습니다.

최적의 PR 요청 크기에 대해(Optimal pull request size)
완벽한 PR 해부 (Anatomy of a perfect pull request)

리뷰 컨벤션

• 정확한 정보와 근거를 바탕으로 리뷰합니다.
  • 필요할 경우 관련 문서를 링크합니다
• 전체 프로젝트 칸반에 리뷰 대기가 2건 이상일 경우 최우선으로 리뷰를 처리합니다

코드 컨벤션

코드 컨벤션은 프로젝트를 진행하면서 필요한것을 추가합니다, 이 섹션에서는 예제가 반드시 포함되어야 합니다.

[argon1025]

빈 변수에 값을 할당해야할 경우 null을 사용합니다

개발자가 의도적으로 값 할당을 하지 않았을 경우 -> null
컴파일러, 인자가 초기화되지 않았을 경우 -> undefined

#10 에서 토론 내용을 참고할 수 있습니다

[argon1025]

Response 에서 null응답 데이터를 전달해야할 경우 undefined 으로 데이터를 전달합니다

#10 에서 토론 내용을 참고할 수 있습니다

[argon1025]

URL은 케밥 케이스로

userData x
user-data o

[argon1025]

Migrations History

prisma/Migrations/readme.md 에서 마이그레이션 히스토리 문서를 기록합니다
문서는 다음 양식을 준수합니다

{ 작업 개요 }

Migration filename : 마이그레이션 파일 명
Pull Request : Link

Detail

작업 내용을 자세히 순서대로 나열합니다

• user.test column 삭제

---

하나의 마이그레이션을 마치면 ------ 선으로 작업을 구분합니다
만약 같은 PR에서 발생한 작업일 경우 구분선을 사용하지 않습니다

[argon1025]

Import 컨벤션

Import는 다음과 같은 컨벤션을 준수합니다

{외부 모듈}
// - enter
{우리가 작성한 provider}
// - enter
{DTO, Type}

[argon1025]

type predicates

type predicates 함수 에서는 매개변수 타입을 any로 받고
반드시 해당 매개변수가 특정 타입인지 판별할 책임을 가집니다

isTestObject(object:any):object is Test{
if(!object) return false; // null or undefined
return 'test' in object; // true or false
}