Git 커밋 약속
About Git
Git과 SourceTree 기본 셋팅
•
커밋 형식: [이름][태그] : 작업 내용 요약
•
태그: 작업의 성격(EDA, Pre, Model 등)을 명시합니다.
•
내용: 끝은 항상 '~ 추가', '~ 수정', '~ 완료' 등 동사로 마무리하여 가독성을 높입니다.
태그 안내:
[EDA] : 통계 분석, 그래프 시각화, 데이터 타입 변경, 테이블 병합(Join/Merge)
[Pre] : 결측치 처리, 이상치 제거, 데이터 타입 변경, 테이블 병합(Join/Merge)
[Model] : 머신러닝 모델 구축 및 평가
[Docs] : README, 마일스톤 등 문서 수정
[Fix] : 잘못된 코드나 오류 수정
브랜치 안내:
01-eda
02-pre
03-model
Docs, Fix 등은 어디에나 커밋해도 상관 없음
Master
예시: [권유석][Pre] : 배송 완료일 결측치 중앙값 대체 완료
핵심 주의사항
•
한 번에 한 일만 커밋하기:
데이터 로드와 그래프 작성을 동시에 했다면, 소스트리에서 파일을 따로 선택하여 [Data] 커밋 한 번, [EDA] 커밋 한 번으로 나누어 진행해 주세요!
•
대용량 CSV 파일 업로드 금지:
Olist 원본 데이터는 용량이 매우 큽니다. 데이터 자체는 올리지 마세요. 대신 데이터를 처리한 **결과 코드(.ipynb 또는 .py)**를 올리는 것이 원칙입니다. (데이터는 각자 로컬 폴더에 보관!)
gitignore에 *.csv 를 추가하면 아주 편리하답니다
•
작업 전 Pull, 작업 후 Push: 동료의 작업물과 충돌하지 않도록 시작 전엔 항상 Pull부터 눌러주세요.
매우 중요합니다. 안그러면 파일이 꼬이는 현상이 발생할 수 있습니다ㅠㅠ
추천하는 작업 흐름 (Workflow)
1.
feature/01-data 작업 완료 → main으로 병합(Merge).
2.
main에서 다시 feature/02-eda 브랜치 생성 후 작업.
3.
이 과정을 반복하여 프로젝트를 쌓아가면 굿
장점ys_
1.
특정 단계에서 에러가 나도 이전 단계로 쉽고 깨끗하게 되돌릴 수 있음
SSH 키 설정
1. Windows에서 SSH 키 생성 및 등록
윈도우용 SourceTree는 기본적으로 PuTTY 방식을 사용하거나 OpenSSH 방식을 선택할 수 있습니다. 최근에는 OpenSSH가 표준이므로 이를 기준으로 설명합니다.
Step 1: SSH 키 생성
1.
SourceTree를 실행합니다.
2.
상단 메뉴에서 [도구(Tools)] > [SSH 키 생성 또는 가져오기(Create or Import SSH Keys)]를 클릭합니다.
3.
PuTTY Key Generator(PuTTYgen) 창이 뜹니다.
4.
아래쪽 'Parameters'에서 RSA 또는 Ed25519(권장)를 선택하고 Generate 버튼을 누릅니다.
5.
마우스를 빈 공간에서 계속 움직여서 키 생성을 완료합니다. → 진짜 해야함
6.
Save private key를 눌러 내 컴퓨터 안전한 곳에 저장하세요 (확장자 .ppk).
7.
상단의 'Public key for pasting...' 박스에 있는 전체 텍스트를 복사해둡니다.
Step 2: SourceTree 설정
1.
[도구] > [옵션(Options)]으로 이동합니다.
2.
[일반(General)] 탭의 'SSH 클라이언트 설정'을 확인합니다.
3.
SSH 키 파일 경로에 방금 저장한 .ppk 파일을 등록합니다.
2. macOS에서 SSH 키 생성 및 등록
맥은 유닉스 기반이므로 터미널을 통해 생성하는 것이 가장 깔끔하며, SourceTree가 이 시스템 키를 참조합니다.
Step 1: 터미널에서 키 생성
1.
터미널앱을 엽니다.
2.
아래 명령어를 입력합니다. (이메일 주소는 본인 것으로 수정)Bash
ssh-keygen -t ed25519 -C "your_email@example.com"
3.
파일 저장 경로를 물으면 그냥 Enter를 누릅니다. (기본 경로: ~/.ssh/id_ed25519)
4.
비밀번호(Passphrase) 설정은 보안을 위해 권장하지만, 번거롭다면 그냥 Enter를 두 번 눌러 넘어갑니다.
Step 2: 공개키 복사
1.
아래 명령어를 입력해 생성된 공개키 내용을 확인하고 복사합니다.Bash
cat ~/.ssh/id_ed25519.pub
2.
출력된 ssh-ed25519 ...으로 시작하는 긴 문장을 복사합니다.
3. 원격 저장소(GitHub, GitLab 등)에 등록
복사한 Public Key(공개키)를 서버에 알려줘야 통신이 가능합니다.
1.
GitHub 기준: 우측 상단 프로필 클릭 > Settings > SSH and GPG keys로 이동합니다.
2.
New SSH Key 버튼을 누릅니다.
3.
Title에는 본인의 컴퓨터 이름(예: My-Windows-PC)을 적고, Key 칸에 복사한 내용을 붙여넣습니다.
4.
Add SSH Key를 눌러 저장합니다.
4. SourceTree에서 최종 확인
SourceTree에서 저장소를 클론(Clone)할 때 주소를 HTTPS가 아닌 SSH 주소로 입력해 보세요.
Tip: 윈도우 사용자의 경우 SSH 클라이언트가 PuTTY로 설정되어 있다면, 하단 작업표시줄 트레이 아이콘에 있는 Pageant라는 프로그램에 .ppk 키가 추가되어 있어야 정상 작동합니다.
자주 발생하는 오류
1. Windows (SourceTree + PuTTY/Pageant)
윈도우 소스트리에서 이 오류가 난다면 Pageant라는 인증 에이전트에 키가 등록되지 않았기 때문입니다.
1.
Pageant 확인: 작업 표시줄 오른쪽 하단(트레이 아이콘)에서 모자를 쓴 컴퓨터 모양 아이콘을 찾으세요.
2.
키 추가: 아이콘 우클릭 > Add Key 클릭 > 아까 저장한 .ppk 파일을 선택합니다.
3.
설정 확인: 소스트리 메뉴 [도구] > [옵션] > [일반] 탭에서 'SSH 클라이언트'가 PuTTY/Plink로 되어 있는지 확인하세요. 만약 OpenSSH를 쓰고 싶다면 아래 맥(Mac) 버전 설명을 참고해 id_rsa 경로를 지정해야 합니다.
2. macOS (Terminal)
맥에서는 SSH 키를 생성했어도 시스템(SSH Agent)이 그 키를 기억하지 못하는 경우가 많습니다.
1.
터미널을 열고 아래 명령어를 입력하여 키를 에이전트에 등록합니다.Bash
ssh-add -K ~/.ssh/id_ed25519
(키 파일 이름이 id_rsa라면 이름을 바꿔서 입력하세요)
2.
연결 테스트: 아래 명령어로 서버와 연결이 되는지 직접 확인해 보세요.Bash
ssh -T git@github.com
•
"Hi [계정이름]! You've successfully authenticated..." 문구가 나오면 성공입니다.
3. 공통 체크리스트 (가장 빈번한 실수)
•
주소 형식 확인: 저장소 주소가 https://...가 아닌 git@github.com:유저명/저장소명.git 형태인지 확인하세요.
•
복사 오류: GitHub에 붙여넣을 때 앞뒤로 공백이 들어갔거나, ssh-ed25519 또는 ssh-rsa라는 시작 문구를 빼먹지 않았는지 확인하세요.