🚀 Jira + GitHub 협업 규칙

1. 개념 이해하기

용어	의미
Jira Task	해야 할 일 카드
Branch	해당 작업을 위한 개인 작업 공간
Commit Message	작업 내용을 저장하면서 남기는 기록
Pull Request (PR)	내 작업을 main 브랜치에 합쳐달라고 요청하는 것

2. 작업 예시

Jira에 다음 작업이 있다고 가정한다.

KAN-27 AI 해설 생성 API 구현

3. 브랜치명 규칙

• 형식: feature/KAN-번호-작업명
• 예시:
  • feature/KAN-27-ai-api
  • feature/KAN-35-result-page
  • feature/KAN-16-public-api-test

브랜치 생성 명령어

Bash

 

git checkout main
git pull origin main
git checkout -b feature/KAN-27-ai-api

• git checkout main: 현재 브랜치를 main으로 이동 (팀의 기준 코드가 있는 곳).
• git pull origin main: GitHub에 있는 최신 코드를 내 컴퓨터로 다운로드.
• git checkout -b feature/KAN-27-ai-api: 새로운 브랜치를 만들고 이동 (KAN-27 전용 공간).

세 줄 요약: main 브랜치로 이동 → 최신 코드 받기 → 내 작업용 브랜치 생성

4. 커밋 메시지 규칙

• 형식: KAN-번호 작업 내용
• 예시:
  • KAN-27 AI 해설 생성 API 구현
  • KAN-35 결과 페이지 UI 구현

커밋 명령어

Bash

 

git add .
git commit -m "KAN-27 AI 해설 생성 API 구현"

• git add .: 수정한 파일들을 커밋 대상으로 등록.
• git commit -m "...": 작업 내용을 저장하고 기록을 남김.

5. GitHub에 Push

Bash

 

git push origin feature/KAN-27-ai-api

• 의미: 내 브랜치를 GitHub에 업로드한다.

6. Pull Request(PR) 제목 규칙

• 형식: KAN-번호 작업 내용
• 예시: KAN-27 AI 해설 생성 API 구현
• 의미: KAN-27 작업이 끝났으니 main에 합쳐달라는 요청.

7. Jira 상태 변경 규칙

To Do → In Progress → In Review → Done

상황	Jira 상태
작업 시작	In Progress
PR 생성	In Review
PR Merge 완료	Done

---

8. 전체 작업 흐름

1. Jira에서 작업 확인: KAN-27 AI 해설 생성 API 구현
2. 브랜치 생성: git checkout main → git pull → git checkout -b ...
3. 코드 작성
4. 커밋: git add . → git commit -m "KAN-27 ..."
5. GitHub에 Push: git push origin ...
6. Pull Request 생성: 제목에 Jira 번호 포함
7. 리뷰 후 Merge
8. Jira 상태 변경: Done으로 완료 처리

---

9. 역할별 실제 예시

• AI 담당자
  • Task: KAN-23 프롬프트 설계
  • Branch: feature/KAN-23-prompt-design
  • PR: KAN-23 프롬프트 설계
• Backend 담당자
  • Task: KAN-27 AI 해설 생성 API 구현
  • Branch: feature/KAN-27-ai-api
  • PR: KAN-27 AI 해설 생성 API 구현
• Frontend 담당자
  • Task: KAN-35 결과 페이지 구현
  • Branch: feature/KAN-35-result-page
  • PR: KAN-35 결과 페이지 구현

---

10. 핵심 규칙 한 줄 요약

브랜치명, 커밋 메시지, PR 제목에 반드시 Jira 번호(KAN-xx)를 포함한다.

---

11. 팀원 체크리스트

• [ ] 작업 시작 전: Jira 번호 확인 및 상태를 'In Progress'로 변경. 최신 코드 pull 후 브랜치 생성.
• [ ] 작업 중: 코드 작성 및 수시로 커밋.
• [ ] 작업 완료 후: Push 후 PR 생성. 제목에 번호 포함. Jira 상태를 'In Review'로 변경.
• [ ] 리뷰 완료 후: Merge 확인 후 Jira 상태를 'Done'으로 변경.

요약: 번호 확인 → 브랜치 생성 → 작업 → 커밋 → Push → PR → 리뷰 → Merge → Done

---

12. Jira 사용법 요약

Epic (큰 기능 단위)

• 기획 및 자료조사 / 데이터 수집 / AI 해설 생성 / 백엔드 / 프론트엔드 / 배포 / 발표 준비

Task (실제 세부 작업)

• 사용자 페르소나 정의 / 공공 API 조사 / 프롬프트 설계 / 결과 페이지 구현

Priority (우선순위)

• Highest: 지금 당장 해야 함
• High: 매우 중요
• Medium: 일반
• Low: 여유 있을 때