[6주차] [202212-17] 협업을 위한 준비, 프로젝트 세팅 (feat. README.md)

오늘은 오전 회의때 프런트와 백 모두 모여, 기본적인 github 협업 툴을 사용하는 법에 대해 팀원과 공유하고, 컨벤션을 정했다.

• pritter 익스텐션을 사용해서 각자 VS Code에 다운로드 했고, .prettierrc 파일에 룰을 몇가지 설정하여 깃헙 레포지토리를 통해 공유했다. 원래는 eslint를 같이 사용하고자 했으나, 처음 접하는 익스텐션에 어려움을 느끼는 분들이 계셔 프리티어만 적용하기로 했고, 대신 프리티어 규칙을 지난번에 비해 몇가지 더 추가/수정했다.

module.exports = {
    arrowParens: 'always',
    bracketSpacing: true,
    jsxBracketSameLine: false,
    jsxSingleQuote: false,
    printWidth: 80,
    proseWrap: 'always',
    quoteProps: 'as-needed',
    semi: true,
    singleQuote: true,
    tabWidth: 4,
    trailingComma: 'es5',
    useTabs: false,
};

• 이후, 간단한 깃 커밋 메세지 컨벤션도 팀원들과 공유하였다.

FEAT : 새로운 기능에 대한 커밋
FIX : 파일 수정에 대한 커밋
BUILD : 빌드 관련 파일 수정에 대한 커밋
CHORE : 그 외 자잘한 수정에 대한 커밋(기타변경)
CI : CI 관련 설정 수정에 대한 커밋
DOCS : 문서 수정에 대한 커밋
STYLE : 코드 스타일 혹은 포맷 등에 관한 커밋
REFACTOR : 코드 리팩토링에 대한 커밋 test : 테스트 코드 수정에 대한 커밋

백엔드 협업을 위해서는 백엔드 레포지토리에 아래의 것들을 추가하였다.

• 공동으로 사용할 모듈 및 프로젝트 세팅을 위한 기본 명령어를 package.json script에 추가, package.json & package-lock.json 레포에 추가
• 처음 레포지토리를 클론한 후 어떻게 프로젝트 세팅을 해야하는지에 대한 상세 가이드 및 프로젝트에서 사용할 공통 에러 클래스와 에러 핸들러의 작동 방식을 README.md 문서에 작성하여 레포에 공유
• db 설정을 위한 migration & models 파일 공유

 

GitHub - hanghae10-w6-team5/backend