HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
🧚
[1기]최종 프로젝트 데브코스
/
[팀3] 아이육
[팀3] 아이육
/
🎁
Backend Ground Rule
🎁

Backend Ground Rule

최종 편집일
May 19, 2022 01:30 AM
날짜
Nov 23, 2021 06:22 PM
상태
규칙
담당자
현호 유BJ Lee

✏️ Intro

🧑‍💻백엔드 팀원 3명은 다음과 같은 룰에 따라 프로젝트를 진행합니다.
 

⏰ 코어타임

  • 오프라인 모임이 없는 날 : 10:30 ~ 19:00, 23:00 ~ Free
  • 오프라인 모임 : 14:00 ~ 19:00
  • 주말은 자유롭게
 

🔖 회고

  • 데일리 회고를 작성한다. (최대한 가볍게, 그날의 느낀점으로)
  • 주간 회고를 작성한다. (잘한점, 부족한점)
 

🚀 프로젝트 관리

프로젝트 관리
  • GitHub를 사용하여 프로젝트를 관리한다.
  • Git-Flow전략을 적용하여 브랜치를 관리한다.
  • 개발할 목록을 이슈로 작성한다.
    • 이슈 예시
      이슈 예시
  • 이슈 번호로 PR을 작성한다.
    • PR 예시
      PR 예시
  • PR의 내용은 적용된 템플릿에 맞게 작성한다.
    • notion image
  • Merge는 반드시 팀원 1명 이상의 리뷰가 필요하다.
  • GitHub Action에 적용된 룰에 따라 테스트 커버리지, 코드 컨벤션, 빌드 실패시 머지가 불가능하다.
  • 커밋 네이밍은 다음과 같다.
    • feat: 새로운 기능 추가 fix: 버그 픽스 docs: 문서 수정 style: 포맷, 세미콜론 수정, Optimize import, Code clean up 등 코드가 아닌 스타일에 관련된 수정 refactor: 코드 리펙토링 test: 테스트 코드 추가 chore: 빌드 관련 업무 수정(안드로이드의 경우 builde.gradle, manifest)
 

📐코드 컨벤션

코드 컨벤션
  • 기본적으로 캠퍼스 핵데이 Java 코딩 컨벤션 룰에 따른다.
    • 캠퍼스 핵데이 Java 코딩 컨벤션
      약어가 클래스명에서 대문자로 들어가면 단어 간의 구분을 인지하기에 불리하다. 약어가 연속된 경우 더욱 가독성을 해친다. 예를 들면 XMLRPCHTTPAPIURL과 같은 경우이다. 그래서 기본 정책으로는 약어의 중간단어를 소문자로 표기하고 프로젝트별로 모두 대문자로 표기할 약어의 목록을 명시하는 방식이 가독성을 높이고 규칙을 단순화하는데 유리하다. 즉 프로젝트 내에서 정의한 단어 목록이 없다면 'XmlRpcHttpApiUrl'과 같이 쓴다.
      https://naver.github.io/hackday-conventions-java/
      캠퍼스 핵데이 Java 코딩 컨벤션
  • 단 indent 단위는 스페이스바 4칸을 적용한다.
  • gradle check style을 적용한다.
  • 한 줄은 120자를 넘지 않는다.
네이밍 컨벤션
  • dto naming
API 컨벤션
  • 응답은 항상 일관적인 포멧을 사용한다.
테스트 컨벤션
  • @DisplayName 어노테이션을 사용하여 테스트 이름을 가독하기 좋게 작성한다.
  • given, when, then 명시한다. (자동 완성 활용)
  • 테스트는 최대한 단위테스트, 경량화를 고민해보고 작성한다.
  • 예외 처리에 대한 테스트를 반드시 작성한다.
로그 컨벤션 (회의중)
  • INFO
  • DEBUG
  • ERROR
 

Commit 컨벤션

  • feat: 새로운 기능 추가
  • fix: 버그 픽스
  • docs: 문서 수정
  • style: 포맷, 세미콜론 수정, Optimize import, Code clean up 등 코드가 아닌 스타일에 관련된 수정
  • refactor: 코드 리펙토링
  • test: 테스트 코드 추가
  • chore: 빌드 관련 업무 수정(안드로이드의 경우 builde.gradle, manifest)
 

브랜치 전략

  • git flow
  • feature/{issueNumber}
 

PR 컨벤션

  • 최소 1명으로 승인
  • 하던거 마무리 하고 바로 리뷰하는 형식으로
  • description 잘 작성하자
  • 커밋 잘 짜르기
  • 네이밍 규칙
    • [#{IssueNumber}] 00000 기능 구현
 
pr 규칙
  • 최소 1명으로 승인
  • 하던거 마무리 하고 바로 리뷰하는 형식으로
  • description 잘 작성하자
  • 커밋 잘 짜르기
  • 네이밍 규칙
    • [CP-{IssueNumber}] 00000 기능 구현