깃헙 협업하기 (feet. 프로젝트 칸반보드, 이슈, PR)

📝 프로젝트 칸반보드 생성

협업할 레포지토리에서 프로젝트 칸반보드(Projects)를 생성하기를 클릭합니다.

프로젝트 칸반보드(Project board) 이름을 작성하고 템플릿란에서 Automated kanban 을 설정합니다. Automated kanban으로 설정해야 이슈와 PR이 자동으로 칸반보드에서 관리가 됩니다.

프로젝트 칸반보드가 생성되었습니다. To do 에 자동으로 생성된 내용은 삭제 해도 됩니다.

🌊 칸반보드 진행

To do → In progress → Done

🎡 협업 사이클

1. 이슈를 생성하고 pojects(칸반보드)를 추가합니다.

   • 생성한 이슈에서 pojects 를 설정합니다.
     - 작업을 시작하거나 진행중이라면 pojects 의 상태를 In progress로 변경합니다.(선택)

2. develop에서 파생되는 브랜치를 생성합니다.

3. 로컬에서 git remote update 명령어로 branch 상태를 업데이트합니다.

4. 로컬에서 해당 브랜치로 작업을 진행합니다.

5. 작업이 완료되면 commitizen 을 활용하여 push합니다.

6. 깃헙 레포지토리에서 작업한 브랜치 → develop 으로 PR을 작성합니다.

7. PR을 작성하면서 reviewer, assignees, pojects(칸반보드), Linked Issues를 설정합니다.

   1. PR 내용부분에 - Closed #이슈번호 를 작성합니다. (해당 PR이 Merge가 되면 연결된 이슈가 Closed됩니다.)

   2. 생성한 PR에서 pojects 의 상태를 Review in progress로 변경합니다.

8. reviewer 들의 리뷰가 완료되면 merge 를 진행합니다.

9. pojects(칸반보드)로 이동하여 작업한 이슈와 PR카드를 Done 으로 이동시킵니다.

🧑🏻‍💻 컨벤션

브랜치명

<!-- 컨벤션 -->
타입/#이슈번호/세부내용

<!-- 예시 -->
feat/#27/Button

이슈 제목

<!-- 컨벤션 -->
[타입] 내용 

<!-- 예시 -->
[feat] Component Base - Button

PR 제목

<!-- 컨벤션 -->
타입 : #이슈번호/내용

<!-- 예시 -->
feat : #27/Component Base - Button 기능 개발

프로젝트의 .github폴더에 아래의 파일 생성
PULL_REQUEST_TEMPLATE.md
ISSUE_TEMPLATE.md
각 파일에 아래와 같은 기본적인 내용을 작성할 수 있다.

이슈 템플릿

## 🚅 Issue 한 줄 요약

이슈를 한줄로 요약해주세요.

## 🤷 Issue 세부 내용

무슨 이슈인가요?

## ✨ 기대 결과

어떤 결과물을 원하시나요?

## 📸 스크린샷

이슈에 해당하는 부분을 보여주세요.

PR 템플릿

## 🚅 PR 한 줄 요약

PR을 한줄로 요약해주세요.

## 🧑‍💻 PR 세부 내용

수정/추가한 내용을 적어주세요.

## 📸 스크린샷

스크린샷을 첨부해주세요.

💡 PR 규칙

• merge를 하기 전에는 “오류“가 없는지, “필요없는 파일“이 있는지 확인해주세요!
• merge를 할 땐 PR에서 동료들의 “확인” 커멘트를 받고 merge를 진행해주세요!
• PR을 작성할 때는 어떠한 작업을 했는지 대략적으로라도 세부내용을 작성해주세요!
• PR에서 디테일하게 피드백을 받고싶다면 피드백 요청 라벨을 달아주세요!
• 동료의 PR을 올라왔을 때 피드백 요청 라벨이 아니라면 가급적 빠른시일내로 간단하게 코드를 확인하고 “확인” 코멘트를 남겨주세요.
• 동료의 PR을 확일할 때는 동료의 코드에서 에러가 발생할수 있는 부분이 있는지 우선적으로 확인해주세요!