gdgoc-kmu-docs

GDGoC KMU의 공통 관리 문서 아카이브

📂 GitHub Repository Naming Guide

레포지토리 관리를 위한 네이밍 규칙입니다. 모든 레포지토리는 아래의 구조를 따릅니다:

🔑 기본 구조

[카테고리]-[목적]-[세부내용]-[학기/연도]

구성 요소

1. 카테고리
   프로젝트 유형을 명확히 구분합니다:
   • proj: 프로젝트
   • study: 스터디
   • archive: 아카이빙/기록용
2. 목적
   레포지토리의 주제를 간결히 표현합니다 (1~3 단어).
   예: 프로젝트명, 스터디 주제, 기록 대상 등.
3. 세부내용 (선택 사항)
   필요에 따라 추가 설명을 포함합니다.
   예: 사용 기술 스택, 프로젝트의 세부 주제 등.
4. 학기/연도
   학기 단위(24-1, 24-2) 또는 연도(24)로 시점을 명시합니다.

---

✨ 네이밍 예시

1️⃣ 프로젝트

• proj-campus-app-24-2 : 24년 2학기 캠퍼스 앱 개발 프로젝트
• proj-iot-dashboard-25-1 : 25년 1학기 IoT 대시보드 프로젝트

2️⃣ 스터디

• study-react-hooks-24-2 : 24년 2학기 React Hooks 학습
• study-python-basics-25-1 : 25년 1학기 Python 기초 스터디
• study-system-design-24-1 : 24년 1학기 시스템 설계 스터디

3️⃣ 아카이빙

• archive-tech-talks-24 : 24년 Tech Talks 자료 모음
• archive-meeting-notes-25-1 : 25년 1학기 회의록 정리
• archive-design-assets-24 : 24년 디자인 자료 아카이빙

---

📋 네이밍 가이드라인

• 고정된 카테고리 사용: proj, study, archive로 시작합니다.
• 명확하고 간결한 목적 작성: 주제는 1~3 단어로 요약합니다.
• 학기/연도 표기 일관성 유지: 학기 단위(24-1, 24-2)로 구분합니다. 학기별로 관리하지 않는 자료는 연도(24)만 사용 가능합니다.
• 소문자와 하이픈(-) 사용: 대소문자를 혼용하지 않고 소문자로 통일하며, 공백 대신 하이픈을 사용합니다.
• 중복 방지: 이름이 비슷한 레포지토리를 방지하기 위해 학기/연도 표기를 필수로 포함합니다.

---

💡 추가 팁

• 기술 스택 강조: 특정 기술 중심 프로젝트/스터디는 기술 스택을 포함합니다.
  예: study-vue-basics-24-2, proj-django-api-25-1
• 범용 네이밍 고려: 학기와 무관한 레포는 학기 표기를 생략 가능합니다.
  예: archive-community-notes, proj-public-api-docs
• 가독성 유지: 이름을 짧고 직관적으로 유지하며, 중복되지 않도록 주의합니다.