README.md 추가
This commit is contained in:
@@ -0,0 +1,276 @@
|
||||
# 한세로 Git 저장소 관리 규칙
|
||||
|
||||
한세로 Git 저장소는 소스 코드 이력 관리와 협업을 위한 공간입니다.
|
||||
NAS 폴더 구조는 기존처럼 유지하되, Git 저장소는 프로그램 단위로 생성합니다.
|
||||
|
||||
---
|
||||
|
||||
## 1. 기본 원칙
|
||||
|
||||
* Git에는 소스 코드만 올린다.
|
||||
* 설치파일, 실행파일, 빌드 결과물, 대용량 데이터는 올리지 않는다.
|
||||
* 저장소는 고객사/공장/프로그램 단위로 구분한다.
|
||||
* 저장소 이름은 영어, 숫자, 하이픈만 사용한다.
|
||||
* 저장소 설명은 한글로 작성한다.
|
||||
|
||||
---
|
||||
|
||||
## 2. 저장소 이름 규칙
|
||||
|
||||
저장소 이름은 아래 형식을 사용한다.
|
||||
|
||||
```text
|
||||
번호-고객사-공장-프로그램명
|
||||
```
|
||||
|
||||
예시:
|
||||
|
||||
```text
|
||||
01-hmc-ulsan-bolt-inspection
|
||||
02-kia-gwangju-misassembly-inspection
|
||||
03-hmc-jeonju-vision-system
|
||||
98-internal-hai-studio
|
||||
98-internal-groupware
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 번호 규칙
|
||||
|
||||
| 번호 | 구분 |
|
||||
| -- | ------------ |
|
||||
| 00 | 의왕 및 남양 연구소 |
|
||||
| 01 | 현대자동차 울산공장 |
|
||||
| 02 | 기아자동차 광주공장 |
|
||||
| 03 | 현대자동차 전주공장 |
|
||||
| 04 | 해외 공장 |
|
||||
| 10 | 삼표 시멘트 청주 공장 |
|
||||
| 11 | 안양 모비스 |
|
||||
| 12 | 중국 광저우 |
|
||||
| 13 | 체코 모비스 |
|
||||
| 80 | KMMG |
|
||||
| 97 | 통합 / 공통 |
|
||||
| 98 | 사내 |
|
||||
| 99 | 기타 |
|
||||
|
||||
---
|
||||
|
||||
## 4. 고객사 약어
|
||||
|
||||
| 고객사 | 약어 |
|
||||
| ------- | -------- |
|
||||
| 현대자동차 | hmc |
|
||||
| 기아자동차 | kia |
|
||||
| 모비스 | mobis |
|
||||
| 삼표시멘트 | sampyo |
|
||||
| 한세로 사내 | internal |
|
||||
| 공통 / 통합 | common |
|
||||
|
||||
---
|
||||
|
||||
## 5. 공장 / 지역 약어
|
||||
|
||||
| 지역 / 공장 | 약어 |
|
||||
| ------- | --------------- |
|
||||
| 울산 | ulsan |
|
||||
| 전주 | jeonju |
|
||||
| 광주 | gwangju |
|
||||
| 남양 | namyang |
|
||||
| 의왕 | uiwang |
|
||||
| 안양 | anyang |
|
||||
| 청주 | cheongju |
|
||||
| 중국 광저우 | china-guangzhou |
|
||||
| 체코 | czech |
|
||||
| 해외 | overseas |
|
||||
|
||||
---
|
||||
|
||||
## 6. 프로그램명 작성 규칙
|
||||
|
||||
프로그램명은 기능을 알 수 있게 작성한다.
|
||||
|
||||
예시:
|
||||
|
||||
```text
|
||||
bolt-inspection
|
||||
pin-inspection
|
||||
label-inspection
|
||||
underbody-inspection
|
||||
misassembly-inspection
|
||||
vision-system
|
||||
mes-interface
|
||||
groupware
|
||||
hai-studio
|
||||
hansero-chat
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. 저장소 설명 작성 규칙
|
||||
|
||||
저장소 설명은 한글로 작성한다.
|
||||
|
||||
예시:
|
||||
|
||||
| 저장소명 | 설명 |
|
||||
| ------------------------------------- | ---------------------- |
|
||||
| 98-internal-hai-studio | 한세로 AI 트레이너 |
|
||||
| 98-internal-groupware | 한세로 그룹웨어 |
|
||||
| 01-hmc-ulsan-bolt-inspection | 현대자동차 울산공장 볼트 검사 프로그램 |
|
||||
| 02-kia-gwangju-misassembly-inspection | 기아자동차 광주공장 오장착 검사 프로그램 |
|
||||
|
||||
---
|
||||
|
||||
## 8. Git에 올릴 것
|
||||
|
||||
아래 항목은 Git에 올린다.
|
||||
|
||||
```text
|
||||
소스 코드
|
||||
프로젝트 파일
|
||||
솔루션 파일
|
||||
README.md
|
||||
설정 샘플 파일
|
||||
DB 스크립트
|
||||
간단한 문서
|
||||
간단한 샘플 데이터
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Git에 올리지 않을 것
|
||||
|
||||
아래 항목은 Git에 올리지 않는다.
|
||||
|
||||
```text
|
||||
bin
|
||||
obj
|
||||
.vs
|
||||
exe
|
||||
dll
|
||||
zip
|
||||
설치파일
|
||||
빌드 결과물
|
||||
런타임 폴더
|
||||
학습 데이터
|
||||
학습 모델
|
||||
대량 이미지
|
||||
로그 파일
|
||||
현장 백업 파일
|
||||
비밀번호 / API Key / 인증서
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 10. .gitignore 기본 규칙
|
||||
|
||||
각 저장소에는 반드시 `.gitignore`를 만든다.
|
||||
|
||||
기본 예시:
|
||||
|
||||
```gitignore
|
||||
.vs/
|
||||
bin/
|
||||
obj/
|
||||
artifacts/
|
||||
*.user
|
||||
*.suo
|
||||
*.log
|
||||
|
||||
*.zip
|
||||
*.exe
|
||||
*.dll
|
||||
*.msi
|
||||
|
||||
runs/
|
||||
*.pt
|
||||
*.onnx
|
||||
*.engine
|
||||
|
||||
PortableRuntime/
|
||||
OfflineRuntime/
|
||||
|
||||
.env
|
||||
appsettings.Production.json
|
||||
config.local.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. 기존 NAS 폴더와 Git 역할
|
||||
|
||||
기존 NAS 폴더는 그대로 유지한다.
|
||||
|
||||
```text
|
||||
NAS 폴더
|
||||
→ 납품본, 설치파일, 현장 백업, 이미지, 문서 보관
|
||||
|
||||
Git 저장소
|
||||
→ 소스 코드, 수정 이력, 협업 관리
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 12. 저장소 생성 예시
|
||||
|
||||
### 사내 프로그램
|
||||
|
||||
```text
|
||||
98-internal-hai-studio
|
||||
98-internal-groupware
|
||||
98-internal-hansero-chat
|
||||
```
|
||||
|
||||
### 현대자동차 울산공장
|
||||
|
||||
```text
|
||||
01-hmc-ulsan-bolt-inspection
|
||||
01-hmc-ulsan-pin-inspection
|
||||
01-hmc-ulsan-underbody-inspection
|
||||
```
|
||||
|
||||
### 기아자동차 광주공장
|
||||
|
||||
```text
|
||||
02-kia-gwangju-misassembly-inspection
|
||||
02-kia-gwangju-vision-system
|
||||
```
|
||||
|
||||
### 통합 / 공통
|
||||
|
||||
```text
|
||||
97-common-vision-library
|
||||
97-common-mes-interface
|
||||
97-common-inspection-runtime
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 13. 권한 관리
|
||||
|
||||
* 조회만 필요한 사용자는 Read 권한
|
||||
* 소스 수정 및 Push가 필요한 사용자는 Write 권한
|
||||
* 저장소 설정 변경이 필요한 관리자는 Admin 권한
|
||||
|
||||
일반 개발자는 기본적으로 Write 권한을 사용한다.
|
||||
|
||||
---
|
||||
|
||||
## 14. 기본 작업 순서
|
||||
|
||||
```text
|
||||
1. 저장소 생성
|
||||
2. README.md 작성
|
||||
3. .gitignore 작성
|
||||
4. 소스 코드 추가
|
||||
5. commit
|
||||
6. push
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 15. 주의사항
|
||||
|
||||
저장소 이름은 한 번 정하면 계속 사용하므로 신중하게 정한다.
|
||||
한글 설명은 자유롭게 사용하되, 저장소 이름은 영어/숫자/하이픈으로 통일한다.
|
||||
대용량 파일은 Git에 올리지 않고 NAS 공유 폴더 또는 Gitea Release로 별도 관리한다.
|
||||
Reference in New Issue
Block a user