깃헙 레파지토리 네이밍 컨벤션

레파지토리명을 짓는데도 네이밍 컨벤션이 있을까? 

모놀리틱 서비스에서 마이크로 서비스로 이행하는 작업을 하면서

여러 개의 레파지토리를 생성해야 하는 일이 생겼는데, 레파지토리 이름을 어떻게 지을 것인가에 대한 의문이 있었다.

그래서 검색을 해보니, 브랜치, 커밋 등에 대한 가이드를 https://github.com/agis/git-style-guide 제공하는 문서인

깃 스타일 가이드는 있어도, 레파지토리 네이밍에 대한 문서는 따로 없었다.

그러던 중 이 사이트에서 괜찮은 글을 찾았다. https://moduscreate.com/blog/github-semantic-naming/

(이 문서에 포함된 유투브 링크도 참고) 아주 짧고 핵심만 잘 담은 영상이라 이것만 봐도 될 것 같다. https://www.youtube.com/watch?v=DCahJsLdPUQ&t=54s

Try a Semantic Approach to Naming GitHub Repositories

 

위 링크의 글과 영상을 요약해서 정리하자면 레파지토리 이름을 붙일 때 정해야 할 것은 크게 두 개가 있다.

1. seperator (구분자) 

- 레파지토리 이름을 어떤 것으로 구분할 것인가?

 

리서치에 따르면 가장 많이 쓰이는 구분자는 하이픈이다. 내 개인적인 생각으로도 소문자로만 나열하고 하이픈으로 구분한 것이 가독성이 가장 좋은 것 같다. 특히 이름이 길어지면 길어질수록 카멜케이스나 파스칼케이스는 읽기 어렵다. 

 

2. 섹션

섹션을 몇 파트로, 그리고 어떤 기준으로 구분할 것인가? 이 섹션에 어떤 정보를 나타내야 할 것인가?

 

 

예를 들어, 프로젝트명-프로젝트목표-언어 가 될 수도 있고, 프레임워크나, 팀에서 중요하게 생각하는 어떤 정보도 될 수 있다.

아래의 캡쳐에 다양한 예시가 있다.

 

 

 

위 두 가지의 기준으로 레파지토리 네이밍 컨벤션을 정한 이후에는 당연하지만 이를 잘 지키는 것이 중요하다.