develop-rules/git-repository-naming.md

Git Repository Naming Rules

Repository의 명칭 규칙

공통 Repository 적용 규칙

• Kebab-Case 사용 (소문자 + 하이픈)
  • 예시 : community-crawler, game-server, ...
• 명확한 명칭 (이 프로젝트가 무슨 프로젝트인지)
  • 약어보다는 가급적 풀네임 사용 권장
• 길지 않아야 함. (3~4단어 이내로)

프로젝트 Repository 적용 규칙

• 프로젝트의 명칭과 동일하게 함. (약칭인 경우, 약칭 그대로 사용)
• 기능 별 Repository를 사용할 경우
  • kebab-Case를 사용하여 구분할 수 있게 적용
    • 예시 : project-a-front, project-a-crawler, ...

조직(Organization)으로 분리한 프로젝트 Repository 적용 규칙

• 명칭에 프로젝트 명칭이나 조직명이 들어가지 않도록 함.
  • 왜? : 중복되어서 보이므로, 가독성 저하
    • 잘못된 예시 : game-a/game-a-client, game-a/game-a-server, ...
      위와 같이 'game-a'라는 프로젝트 명이 불필요하게 중복되어서 보임.
      + 명칭의 길이가 불필요하게 길어짐.
  • 올바른 예시 : game-a/client, game-a/server, ...