Github 기능 사용법

Github Project

키퍼 홈페이지 백엔드 리뉴얼2 Project

github에 있는 project 기능은 프로젝트를 진행할 때 편리하게 프로젝트 관리를 할 수 있게 도와주는 기능입니다.

• 아래처럼 칸반보드 형식의 작업환경 구성이 가능합니다.

  

생성 및 설정하기

• New Project

  

• Column Type 지정

  

1. To Do 설정

   

2. In Progress 설정

   

3. Done 설정

   
   • 추가 설명
     • Approved by reviewer : PR이 최소 필수 approving review를 받으면 자동으로 이 Column으로 이동하겠다는 말입니다. Pending approval by reviewer가 활성화 된 경우 권장한다고 합니다.
   • Pending approval by reviewer : 리뷰어가 requests changes를 하거나, 필요한 최소 승인 리뷰 수를 충족하지 못할 때 자동으로 이 Column으로 이동하겠다는 말입니다. Approved by reviewer 설정이 활성화 된 경우 권장된다고 합니다.

카드 등록하기

두 가지 방법으로 카드를 등록할 수 있습니다.

1. 카드로 등록하기

   • Project Column에 Add를 누르면 Card 등록이 가능합니다.
   
   • 위와 같이 등록하는 카드는 Issue가 아닌 그냥 카드로 사용됩니다.
   • Issue로 등록하고 싶으면 아래와 같은 방법을 사용하거나, 2번 이슈로 등록하기를 사용해야 합니다.
   

2. 이슈로 등록하기

   • Github repository안에 Issue탭에서 이슈를 생성합니다.
   

Github Milestone

키퍼 홈페이지 백엔드 리뉴얼2 Milestone

github milestone 기능은 프로젝트의 진행 현황을 보기 쉽게 도와주는 기능입니다.

github의 Issues 탭에서 Milestone을 생성할 수 있습니다.

생성하면 아래와 같이 기간안에 얼마나 완료됐는지 확인할 수 있습니다.

Github Issue

키퍼 홈페이지 백엔드 리뉴얼2 Issue

issue는 해야 할 Task 단위로 생성하고 있습니다.

Github Issues 탭에서 생성할 수 있습니다.

생성하기를 누르면 아래와 같은 페이지가 등장합니다.

Title	제목을 설정하면 됩니다.
Description	자세한 내용을 설정할 수 있으며, 세부 Check list를 생성할 수도 있습니다.
Assignees	Issue 책임자를 설정할 수 있습니다.
Labels	어떤 태그가 들어가는지 설정할 수 있습니다.
Projects	위에서 설정했던 Project에 Issue를 등록할 수 있습니다.
Milestone	위에서 설정했던 Milestone에 Issue를 등록할 수 있습니다.

Issue를 생성하면 아래와 같은 페이지가 등장합니다.

• Issue 옆에 번호가 나타나는데, Commit이나 Pull Request에서 링크를 할 때 사용됩니다.

내용 작성은 md파일 형식으로 작성됩니다.

Write 우측 Preview로 어떤 식으로 만들어지는 지 확인이 가능합니다.

issue close 하기

#{이슈 id} 붙여서 커밋하면 해당 issue에 커밋이 뜹니다.

Close issue 하면 이슈를 닫을 수 있습니다.

프로젝트에 등록된 이슈라면, close 했을 때 자동으로 Done으로 이동합니다.