Git Repository Naming Convention
1. 소문자를 사용해라 (use lower case)
2. 대시(-)를 사용해라 (use dashes)
3. 명확하게 작성해라 (be specific)
4. 일관성있게 작성해라 (be consistent)
1️⃣ 소문자를 사용해라
(use lower case)
리포지터리 이름은 소문자로 작성하자.
GitHub는 대소문자를 구분하긴 하지만, 브라우저 URL에서는 자동으로 소문자로 변환되기도 하고,
팀 협업이나 검색 시 혼란을 줄 수도 있음.
❌ MyFirstProject →
✅ my-first-project
2️⃣ 대시(-)를 사용해라
(use dashes)
여러 단어를 연결할 때는 언더바(_)나 카멜표기법(camelCase) 대신 하이픈(-)을 쓰는 게 깔끔하고 가독성이 좋다.
❌ my_project, myFirstProject
✅ my-first-project
URL 형태로 접근할 일이 많은 GitHub에서는 하이픈(-)이 표준처럼 쓰임
3️⃣ 명확하게 작성해라
(be specific)
이름만 봐도 무슨 기술로, 어떤 걸, 왜 만들었는지 알 수 있어야 한다.
❌ test, project1, final-fix
✅ html-css-portfolio, nodejs-rest-api, react-todo-app
특히 포트폴리오나 학습 저장용으로 쓸 때는
기술 스택 + 주제 + 목적 정도만 명확히 들어가 있어도 됨.
4️⃣ 일관성 있게 작성해라
(be consistent)
처음부터 한 가지 네이밍 패턴을 정해서 계속 똑같이 쓰는 게 핵심
예를 들어 아래처럼 정해두면 관리하기도 좋고, 보기에도 통일감이 생긴다.
📌 예시 패턴:
- 기술-주제-study → html-css-portfolio-study, javascript-study
- 출처-주제-study → dreamcoding-react-study, inflearn-nodejs-study
| ✅ 소문자 사용 | 대소문자 혼란 방지 | my-first-app |
| ✅ 대시(-) 사용 | 가독성과 URL 안정성 확보 | react-weather-app |
| ✅ 명확 | 기술/주제/목적이 드러나게 | nodejs-rest-api |
| ✅ 일관성 | 한 가지 패턴 유지 | html-css-study, react-app-study |
소문자로 쓰는 규칙만 알고 있었는데 앞으로 추가할 때는 통일성 있게 만들 예정...
기존 repository도 규칙에 맞게 수정하여 일관성있게 만들어가야겠다.