HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
🧚
[1기]최종 프로젝트 데브코스
/
🐳
[팀11] 모디
/
📌
코딩 컨벤션
📌

코딩 컨벤션

참고 컨벤션
참고 Git flow

개발환경 설정(prettier, eslint, dotenv, material-ui v5, material-ui/icons)

  • node 버전 v14.17.6
  • MUI 5
    • styled component 방식이라 더익숙할수있다.
    • 색상같은 부분은 후에 테마로 지정해주면 될 거같다.
    • @mui/icons-material
    • 폰트 설정 서치( 도르 )
  • dotenv 활용해서 환경변수 처리
  • axios 사용
    • aixos hooks 라이브러리 사용
  • context API

Prettier

{ "printWidth": 80, "tabWidth": 2, "semi": true, "singleQuote": true, "quoteProps": "as-needed", "trailingComma": "all", "bracketSpacing": true, "arrowParens": "always", "proseWrap": "preserve", "endOfLine": "crlf", "htmlWhitespaceSensitivity": "css" }

PR 템플릿

## 👀 이미지 또는 Gif <!-- 구현한 내용의 동작을 담은 이미지, gif 등. 시각화된 내용이 없다면 생략 --> ## 📝 요구 사항 및 구현 내용 <!-- 구현한 내용의 세부 사항 목록과 완료 여부 체크 --> ## 💡 포인트 <!-- 구현한 내용 중 추가 설명, 강조가 필요한 핵심 로직이나 코드 설명. '특히 자세히 봐줬으면 좋겠다!'하는 내용들 --> ## 🚩 이슈 <!-- 해결하지 못한 내용 또는 부족한 점이 있어 추가 논의가 필요할 것 같은 부분에 대한 상세 설명 --> # 이슈 번호

코드리뷰 규칙

  • 리뷰는 개인의 일 각자 알아서하기
  • 당일 merge 는 2명이상 리뷰 했을 경우
  • 다음날까지 1명만 리뷰 했을경우 그냥 merge

git branch 전략

  • 브랜치명
    • [feature]/#티켓번호
  • git-flow

커밋 컨벤션

  • [태그 이름] [#이슈 번호] : [커밋 내용] (한글, 명령형)
    • ex) feat #1 : Text 컴포넌트 구현

태그 목록

  • feat : 새로운 기능을 추가할 경우
  • fix : 버그를 고친 경우
  • style : css, scss, styled component 등의 ui style 작업
  • lint: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
  • refactor : 코드 리팩토링
  • chore : 빌드 태스트 업데이트, 패키지 매니저를 설정하는 경우
  • rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
  • remove : 파일을 삭제하는 작업만 수행한 경우
  • hotfix: 긴급 수정
  • set: 환경설정
  • docs: readme.md 변경