docs: Git 브랜치 및 커밋 메시지 작성 가이드 추가
This commit is contained in:
68
README.md
68
README.md
@ -0,0 +1,68 @@
|
||||
# Gitea 운영 및 개발 워크플로우 가이드
|
||||
|
||||
`gui-gitea-operation` 저장소는 우리 조직의 Gitea를 활용한 프로젝트 관리, 개발 워크플로우, 코드 작성 표준에 대한 모든 가이드를 중앙에서 관리합니다. 일관성 있고 효율적인 개발 문화를 정착시키는 것을 목표로 합니다.
|
||||
|
||||
---
|
||||
|
||||
### 1. 문서 개요 (Documentation Overview)
|
||||
- **문서의 목적 (Purpose)**: 이 저장소는 조직의 모든 구성원이 따라야 할 표준화된 개발 및 운영 절차를 안내하는 공식 문서입니다. Gitea를 중심으로 저장소 생성부터 코드 작성, 배포에 이르는 전 과정을 다룹니다.
|
||||
- **대상 독자 (Target Audience)**: 조직에 소속된 모든 개발자, 연구원, 엔지니어 및 프로젝트 관리자.
|
||||
|
||||
---
|
||||
|
||||
### 2. 목차: 주요 가이드 링크 (Table of Contents: Key Guides)
|
||||
|
||||
이 저장소의 핵심 가이드 목록입니다. 필요한 내용을 빠르게 찾아보세요.
|
||||
|
||||
#### 🚀 **시작하기: 기본 원칙**
|
||||
- **[Repository 명명 규칙](./guide-repository-naming.md)**: 프로젝트 성격에 맞는 저장소 이름을 만드는 방법을 안내합니다.
|
||||
- **[Git 커밋 메시지 컨벤션](./guide-commit-convention.md)**: Conventional Commits 기반의 표준 커밋 메시지 작성법을 설명합니다.
|
||||
- **[Git 브랜치 전략](./guide-branch-convention.md)**: 개인 작업부터 팀 협업, AI 기반 병렬 개발까지 상황별 브랜치 전략을 제시합니다.
|
||||
- (해당 가이드는 현재 디벨롭 중이며 추후 템플릿 레포지토리 개발 후 더 변경 될 수 있습니다.)
|
||||
|
||||
#### 📖 **README 작성 가이드**
|
||||
- **[공통 가이드](./guide-readme/common.md)**: 모든 README에 포함되어야 할 필수 구성 요소를 안내합니다.
|
||||
- **유형별 상세 가이드**:
|
||||
- [모노레포 (Monorepo)](./guide-readme/monorepo.md)
|
||||
- [템플릿 (`tpl-*`)](./guide-readme/tpl.md)
|
||||
- [데이터 분석 (`anl-*`)](./guide-readme/anl.md)
|
||||
- [연구/논문 (`res-*`, `ppr-*`)](./guide-readme/research.md)
|
||||
- [테스트/PoC (`tst-*`, `poc-*`)](./guide-readme/test-poc.md)
|
||||
- [공용 도구/인프라 (`tol-*`, `inf-*`)](./guide-readme/tool-infra.md)
|
||||
- [문서/가이드 (`doc-*`, `gui-*`)](./guide-readme/docs-guide.md)
|
||||
- [라이브러리 (`lib-*`)](./guide-readme/library.md)
|
||||
- [데이터셋 (`dat-*`)](./guide-readme/dataset.md)
|
||||
|
||||
#### 🛠️ **개발 도구 및 설정**
|
||||
- **[Git 커밋 템플릿](./.gitmessage)**: 표준 커밋 메시지 작성을 돕는 템플릿입니다. (`git config commit.template .gitmessage` 명령어로 설정)
|
||||
|
||||
---
|
||||
|
||||
### 3. 문서 구조 (Repository Structure)
|
||||
```plaintext
|
||||
/
|
||||
├── guide-readme/ # 각 Repository 유형별 README 작성 가이드 모음
|
||||
├── guide-branch-convention.md
|
||||
├── guide-commit-convention.md
|
||||
├── guide-repository-naming.md
|
||||
├── .gitmessage # Git 커밋 메시지 템플릿
|
||||
└── README.md # 현재 보고 있는 이 문서
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 4. 문서 업데이트 및 기여 방법 (Contributing to the Docs)
|
||||
이 가이드는 살아있는 문서입니다. 언제든지 내용 추가, 수정, 개선을 제안할 수 있습니다.
|
||||
|
||||
- **기여 절차**:
|
||||
1. [브랜치 전략](./guide-branch-convention.md)에 따라 `docs/주제` 형식의 브랜치를 생성합니다.
|
||||
2. 내용을 수정하거나 새로운 가이드 문서를 추가합니다.
|
||||
3. [커밋 컨벤션](./guide-commit-convention.md)에 맞게 커밋 메시지를 작성합니다.
|
||||
4. Pull Request(PR)를 생성하여 리뷰를 요청합니다.
|
||||
|
||||
- **수정 제안**: 오타 수정이나 내용 보강 등 모든 변경은 Pull Request를 통해 제안해주세요.
|
||||
|
||||
---
|
||||
|
||||
### 5. 검색 팁 (Search Tips)
|
||||
Gitea의 검색 기능을 활용하면 원하는 정보를 쉽게 찾을 수 있습니다. 예를 들어, 이 저장소 내에서 '모노레포' 관련 내용을 찾고 싶다면, 검색창에 `monorepo`를 입력하여 검색 범위를 이 저장소로 한정하면 됩니다.
|
||||
|
||||
Reference in New Issue
Block a user