[assignment_03] 1차 토의 결과

[jun-05]

[assignment_03] 1차 토의 결과

세팅 및 진행

1. CRA에서 불필요한 파일을 제거하고, ESLint / Prettier / husky 설정을 한 프로젝트를 생성하여 PUSH합니다.
2. 셋팅된 프로젝트를 각자 클론하고, branch를 생성하고 작업을 진행합니다.
   2.2 TypeScript로 구현하려는 경우, 클론한 repo에서 TypeScript로 마이그레이션을 진행합니다.
3. 토의를 거쳐 최종적으로 완성된 BestPractice를 main에 merge합니다.

예외

• Next.js를 사용하는 경우 자신의 repo에서 프로젝트를 관리합니다. (ESLint,Prettier,husky 설정 필요)

과제 진행 계획

• 11월 2일 오후 5시에 모여 진행상황을 대략적으로 공유하기로 하였습니다.
• 11월 3일 목요일 저녁 10시까지, 각자 진행한 결과물에 대하여 Discussions 에 올려두기로 하였습니다.
• 11월 4일 아침 9시까지 팀원간의 코드리뷰를 끝내고, 오전 9시 이후, 최종 BestPractice를 선정하기로 하였습니다.

토의 진행

나왔던 논의 List

• 이전 주제의 BestPractice 선정 방법에 대한 방법으로, 우선적으로 각자가 구현사항을 개발하기로 하였습니다.
  • 좋다고 생각되는 구현 방법이나, 구현에 도움이 되는 Lib, 방식등이 있다면 Discussions 을 통해 공유하기로 하였습니다. (idea 카테고리 사용)
  • 공유되는 정보는 참고로 사용되는 정보이며, 기능구현시 꼭 사용할 필요는 없습니다.
• Redux, TypeScript,기타 Lib 사용은 각자 자유롭게 선택하여 사용하기로 하였습니다.
• 코딩 컨벤션에 규칙이 추가되었습니다.
  • axios 인스턴스를 만드는 위치 및 함수명을 통일하였습니다.
  • 데이터 유무를 판별하는 변수. Error값과 같은경우 hasError와 같이 has를 붙이기로 하였습니다.
• Discussion에 카테고리를 일부 변경 하여 수정하고, Label 등을 추가 사용하기로 하였습니다.
• github repo내 wiki 기능을 사용하여 commit 규약과 같은, readMe에서 바뀌지 않는 문서들을 적어두어 활용하기로 하였습니다.
• 불필요한 commit은 지양하고, commit 메시지에 대한 설명을 되도록이면 사용하자는 의견이 있었습니다.
• readMe 파일에 추가되었으면 하는 양식을 Discord에 올려두기로 하였습니다.

[assignment_03] 코딩 컨벤션

• 컴포넌트의 ID사용은 지양한다.
• react의 state는 여러개 사용시 최소 집합을 찾아 사용한다.
• 컴포넌트의 이벤트에서 불필요한 익명함수를 사용하지 않는다. (예시: 함수의 인자가 event 하나인 경우)
• 코드를 설명하는 주석은 가급적 사용하지 않는다.
• 상수는 영문 대문자 스네이크 표기법(Snake case)를 사용한다.(예시: SYMBOLIC_CONSTANTS)
• 반환 값이 불린인 변수는 'is'로 시작한다
• 반환 값의 유무를 사용하는 변수는 has로 시작한다

-예시. loading -> isLoading / Error -> hasError

• const와 let은 사용 시점에 선언 및 할당한다.
• 함수는 사용 전에 선언해야 하며, 함수 선언문은 변수 선언문 다음에 오도록 한다.
• 이벤트 핸들러는 'on'으로 시작한다.
• 한 줄짜리 블록일 경우라도 {}를 생략하지 않으며 명확히 줄 바꿈 하여 사용한다.

한 줄짜리 블록일 경우 {}를 생략할 수 있지만, 이는 코드 구조를 애매하게 만든다. 당장은 두 줄을 줄일 수 있겠지만 이후 오류 발생 확률이 높아 잠재된 위험 요소가 된다.
단, map과 같은 화살표 함수의 암시적 반환은 허용한다.

• API 인스턴스를 만드는 함수는 API/axiosInstance.js 파일내에서 axiosInstance 라는 이름으로 통일한다

참고 링크
https://ui.toast.com/fe-guide/ko_CODING-CONVENTION