본 가이드는 코드 충돌을 방지하고 원활한 협업을 위해 **작업 시작 전(준비)**과 **작업 완료 후(등록)**에 반드시 지켜야 할 절차를 규정합니다.

작업을 시작하기 전, 나의 로컬 환경을 최신 상태로 만들거나 안전한 작업 공간을 확보하는 단계입니다. 현재 상황에 맞춰 A 또는 B 중 하나를 따르세요.

가장 일반적인 절차입니다. main을 최신화한 뒤 브랜치를 생성합니다.

1. 메인 브랜치로 이동

   git checkout main

2. 원격 저장소의 최신 코드 당겨오기 (Update)

   git pull origin main

3. 내 작업용 브랜치 생성 및 이동

   # git checkout -b feature/기능명
   git checkout -b feature/login-page

main 브랜치에서 이미 작업을 시작했다면, 절대 pull 하지 말고 즉시 브랜치를 생성하여 대피합니다.

1. 작업 내용을 그대로 들고 새 브랜치로 이동 (이 명령어를 실행하면 작성 중이던 코드가 새 브랜치로 안전하게 옮겨집니다.)

   # git checkout -b feature/기능명
   git checkout -b feature/signup-api

2. 작업 진행 이동된 브랜치에서 그대로 작업을 이어서 진행합니다.

기능 구현이 완료되면 코드를 저장하고 GitHub에 병합을 요청하는 단계입니다.

내 코드를 GitHub 원격 저장소로 업로드합니다.

1. 변경 사항 스테이징 (Add)

   git add .

2. 변경 사항 기록 (Commit)

   # git commit -m "작업 내용 요약"
   git commit -m "feat: 로그인 API 구현 완료"

3. 원격 저장소로 업로드 (Push)

   # git push origin feature/기능명
   git push origin feature/login-page

터미널이 아닌 GitHub 웹 인터페이스를 통해 안전하게 합칩니다.

1. Pull Request (PR) 생성
   • GitHub 저장소 페이지 접속 -> 상단 경고창의 Compare & pull request 클릭.
   • 방향 확인: base: main ⬅️ compare: feature/기능명
   • 내용 작성 후 Create pull request 클릭.
2. 코드 리뷰 및 병합 (Merge)
   • 팀원 확인 후 이상이 없으면 Merge pull request 클릭.
   • Confirm merge를 눌러 최종 반영.

1. Direct Commit 금지: main 브랜치에 직접 커밋하거나 푸시하지 않습니다.
2. 1기능 1브랜치: 하나의 기능은 하나의 브랜치에서 작업합니다.
3. gitignore 준수: __pycache__, node_modules, .env, 시스템 파일 등은 절대 커밋하지 않습니다.

이 가이드는 GitHub Desktop 사용자를 기준으로 작성되었습니다. 코드 충돌을 방지하기 위해 작업 시작 전과 작업 완료 후에 아래 절차를 반드시 따라주세요.

작업을 시작하기 전, 최신 코드를 받거나 안전한 작업 공간(브랜치)을 만드는 단계입니다.

가장 이상적인 시작 방법입니다. main을 최신화하고 새 브랜치를 팝니다.

1. 메인 브랜치로 이동
   • 상단 [Current Branch] 클릭 → main 선택.
2. 최신 코드 당겨오기 (Update)
   • 상단 [Fetch origin] 클릭.
   • 업데이트가 있다면 버튼이 **[Pull origin]**으로 바뀝니다. 클릭하여 최신 코드를 받습니다.
3. 내 작업용 브랜치 생성
   • 상단 [Current Branch] 클릭 → [New Branch] 버튼 클릭.
   • Name에 feature/기능명 입력 (예: feature/login-page) → [Create Branch] 클릭.
4. 작업 시작

main 브랜치 상태에서 이미 코드를 수정했다면, 절대 [Pull origin]을 누르지 마세요. (충돌 발생 위험)

1. 즉시 새 브랜치 생성
   • 작업하던 그대로 상단 [Current Branch] 클릭 → [New Branch] 클릭.
   • 브랜치 이름 입력 (예: feature/signup-api).
2. 변경 사항 가져오기 (중요 ⭐)
   • 브랜치 생성 버튼을 누르면 팝업창이 뜹니다.
   • "Bring my changes to feature/..." (내 변경 사항을 새 브랜치로 가져오기) 를 선택하고 **[Switch Branch]**를 클릭합니다.
   • Note: "Leave my changes..."를 선택하면 작업 내용이 임시 저장(Stash)되어 보이지 않게 되니 주의하세요.
3. 작업 진행
   • 이제 안전한 브랜치로 이동되었습니다. 작업을 계속하시면 됩니다.

기능 구현이 완료되면 코드를 저장하고 GitHub에 병합을 요청하는 단계입니다.

내 컴퓨터의 코드를 GitHub 원격 저장소로 보냅니다.

1. 변경 파일 확인 (Add)
   • 좌측 Changes 탭에서 내가 수정한 파일이 체크되어 있는지 확인합니다.
   • (불필요한 설정 파일이나 __pycache__ 등이 있다면 우클릭 후 'Ignore file'을 선택해 제외하세요.)
2. 변경 사항 기록 (Commit)
   • 좌측 하단 입력창의 Summary에 작업 내용을 적습니다. (예: feat: 로그인 API 구현 완료)
   • [Commit to feature/...] 파란색 버튼 클릭.
3. 원격 저장소로 업로드 (Push)
   • 상단 탭의 [Publish branch] (또는 [Push origin]) 버튼 클릭.

GitHub 웹사이트로 이동하여 합치는 작업을 수행합니다.

1. PR 생성 버튼 클릭
   • Push가 완료되면 GitHub Desktop 화면 중간에 [Create Pull Request] 버튼이 나타납니다. 클릭하면 웹사이트가 열립니다.
2. 웹사이트에서 내용 작성
   • 방향 확인: base: main ⬅️ compare: feature/기능명
   • 작업 내용을 작성하고 [Create pull request] 클릭.
3. 코드 리뷰 및 병합 (Merge)
   • 팀원 확인 후 이상이 없으면 [Merge pull request] → [Confirm merge] 클릭.

1. Direct Commit 금지: main 브랜치가 선택된 상태에서는 절대 커밋하지 않습니다. (반드시 상단 [Current Branch]가 내 브랜치인지 확인!)
2. Fetch 습관화: 작업을 시작하기 전에는 무조건 main 브랜치에서 **[Fetch origin]**을 한 번 눌러주세요.
3. 1기능 1브랜치: 하나의 기능은 하나의 브랜치에서 작업합니다.