[Github] 깃헙으로 협업하기(Issue, Pull Request, Label)

깃헙으로 팀 프로젝트를 효율적으로 진행하기 위해 Issue와 Pull Request를 주로 사용한다.

무작정 사용하지 말고 템플릿으로 깔끔하게 관리해 보자

Issue, 이슈

작업 시작 전, Issue를 생성한다. 하나의 Issue는 하나의 기능 단위이다.

작업에 맞는 템플릿을 선택하여 작성한다.

이슈 템플릿 생성하기

1. 레포지토리 - Settings

2. General > Features > Issues > Set up templates

3. 템플릿 선택 Custom template > Preview and edit

4. 연필 아이콘을 눌러 편집

• 템플릿 이름, 설명, 내용을 입력한다.

5. 템플릿 작성 후 Propose changes 버튼을 클릭하여 등록(커밋)한다.

 

사용한 이슈 템플릿 예시

Template name
Issue Template

About
이슈 공통 템플릿

Template content

## 📄기능
> 추가하려는 기능에 대해 간결하게 설명해주세요

## ✔작업 상세 내용
- [ ] TODO

## 참고할만한 자료(선택)

Issue default title
[TYPE] 이슈 제목

Template name
Bug Report Template

About
버그 리포트 템플릿

Template content

## 🐞어떤 버그인가요?

> 어떤 버그인지 간결하게 설명해주세요

## ❓어떤 상황에서 발생한 버그인가요?

> (가능하면) Given-When-Then 형식으로 서술해주세요

## 🙆‍♀️예상 결과

> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요

## 참고할만한 자료(선택)

Issue default title
[BUG]

---

PR, Pull Request

코드 리뷰를 위해 PR을 보낸다. PR 내용만 보고도 변경사항을 이해할 수 있게 명시한다.

PR Title은 커밋들의 큰 주제를 사용한다.

생성한 이슈의 ID로 트래킹 할 수 있다.

- #[id] 를 입력하면 이슈와 연결시킬 수 있다.

PR 템플릿 생성하기

1. 레포지토리의 Addfile > Create new file

2. .github/pull_request_template.md 파일 생성

3. 템플릿 작성 후 Commit changes 버튼으로 저장(커밋)

사용한 PR 템플릿 예시

## #️⃣연관된 이슈

> ex) #이슈번호, #이슈번호

## 📝작업 내용

> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

### 스크린샷 (선택)

## 💬리뷰 요구사항(선택)

> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
>
> ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?​

---

커스텀 label 적용하기

1. 원하는 위치에 labels.json 파일을 생성한다.

▶ 사용한 labels.json 파일

// labels.json
[
  {
    "name": "⚙ Setting",
    "color": "e3dede",
    "description": "개발 환경 세팅"
  },
  {
    "name": "✨ Feature",
    "color": "a2eeef",
    "description": "기능 개발"
  },
  {
    "name": "🌏 Deploy",
    "color": "C2E0C6",
    "description": "배포 관련"
  },
  {
    "name": "🎨 Html&css",
    "color": "FEF2C0",
    "description": "마크업 & 스타일링"
  },
  {
    "name": "🐞 BugFix",
    "color": "d73a4a",
    "description": "Something isn't working"
  },
  {
    "name": "💻 CrossBrowsing",
    "color": "C5DEF5",
    "description": "브라우저 호환성"
  },
  {
    "name": "📃 Docs",
    "color": "1D76DB",
    "description": "문서 작성 및 수정 (README.md 등)"
  },
  {
    "name": "📬 API",
    "color": "D4C5F9",
    "description": "서버 API 통신"
  },
  {
    "name": "🔨 Refactor",
    "color": "f29a4e",
    "description": "코드 리팩토링"
  },
  {
    "name": "🙋‍♂️ Question",
    "color": "9ED447",
    "description": "Further information is requested"
  },
  {
    "name": "🥰 Accessibility",
    "color": "facfcf",
    "description": "웹접근성 관련"
  },
  {
    "name": "✅ Test",
    "color": "ccffc4",
    "description": "test 관련(storybook, jest...)"
  }
]

2. Github Access-token을 발급한다.

• 계정 로그인 > Settings > Developer Settings > Personal access tokens > 토큰 발급
• scope - repo 체크

3. label.json이 위치한 루트 폴더에서 다음 명령어를 실행한다.

npx github-label-sync --access-token {토큰 값} --labels ./labels.json {사용자 계정 이름/저장소 이름}

• organization의 경우 사용자 계정 이름 대신 organization name을 작성한다.

변경된 라벨

---