Skip to content

github-onboarding.md

Latest commit

 

History

History
84 lines (64 loc) · 3.3 KB

github-onboarding.md

File metadata and controls

84 lines (64 loc) · 3.3 KB
Raw

GitHub 온보딩 (처음 쓰는 분용)

명령어는 그대로 복사해서 실행하세요. group3, youth-rent만 자기 조/주제로 바꾸면 됩니다.

0. 준비 (1회)

  1. GitHub 계정 생성, 프로필에 실명 또는 닉네임 설정
  2. Git 설치 확인: git --version (없으면 https://git-scm.com)
  3. GitHub CLI 설치 (권장): https://cli.github.com → gh auth login (GitHub.com → HTTPS → 브라우저 로그인)
  4. 커밋 작성자 설정: 
    git config --global user.name "홍길동"
git config --global user.email "GitHub에 등록한 이메일"

1. 초대 수락

2. 내려받기 (clone) 와 환경 설치

gh repo clone CausalInferenceLab/policy-effect-analytics-agent
cd policy-effect-analytics-agent
uv venv -p 3.11 && source .venv/bin/activate   # Windows: .venv\Scripts\activate
make install                                     # make 없으면: uv pip install -e ".[dev]"
cp .env.example .env                             # API 키 입력 (커밋되지 않음)
make check                                       # 통과하면 준비 끝

3. 브랜치 만들기

main에서 직접 작업하지 않습니다. 항상 최신 main에서 새 브랜치를 만드세요.

git switch main
git pull
git switch -c group3/plan

4. 작업하고 커밋하기

cp -r cases/_template cases/group3-youth-rent    # 첫 작업일 때만
# ... plan.yaml 수정 ...
git status                                       # 무엇이 바뀌었는지 확인
git add cases/group3-youth-rent
git commit -m "plan(group3-youth-rent): 질문과 처치·대조 정의"
git push -u origin group3/plan                   # 두 번째부터는 git push
  • git add . 대신 자기 폴더만 add 하는 습관을 들이세요 (.env, 원자료 실수 방지).

5. PR 올리기

gh pr create --fill --base main          # 또는 GitHub 웹에서 "Compare & pull request"
gh pr create --draft --fill              # 아직 작업 중이면 Draft
  1. PR 본문 체크리스트를 채웁니다.
  2. CI(초록 체크)를 기다립니다. 빨간 X면 Details를 눌러 로그를 확인하고, 고쳐서 다시 push 하면 PR이 자동 갱신됩니다.
  3. 조원 또는 멘토 1명 Approve 후 Squash and merge.

6. 병합 후 정리

git switch main
git pull
git branch -d group3/plan

자주 막히는 곳

증상 해결
Permission denied / 403 on push 초대 수락 확인, gh auth login 다시
rejected ... fetch first git pull --rebase 후 다시 push
충돌(conflict) 충돌 파일에서 <<<<<<< 구간 정리 → git add 파일 → git rebase --continue
.env를 실수로 커밋 push 전이면 git reset HEAD~1. push 했다면 즉시 키를 재발급하고 운영진에게 알림
main에 커밋해버림 git switch -c group3/fix 로 브랜치를 만든 뒤 push (main은 보호되어 push 안 됨)
CI의 ruff 에러 로컬에서 make format 후 다시 커밋