GitHub으로 프로젝트 관리- Issue, Project, Milestone

덤벨로퍼·2024년 3월 1일
3

협업프로젝트

목록 보기
1/1
post-thumbnail

📌 issue

📑 새로운 추가될 가능, 개선 해야할 가능, 버그 등등 모든것이 이슈!
팀 프로젝트에서는 모든 활동 내역에 대해서 이슈를 등록하고 그 이슈기반으로 작업을 진행하게 된다.
이슈를 등록할 때 자주 사용하는 템플릿을 등록해서 사용하는 방법이 효율적

1. 레포지토리의 Settings로 들어간다.

2. General 탭에서 아래로 내려보면 Features > Issues 에서 Set up templates 버튼을 클릭

3. 이슈 템플릿 생성


컨텐츠 내용을 작성하고 default title 을 줄 수 있음!
이슈 생성시 이름 앞에 [FEAT] 붙이는 설정
ex) [FEAT] 로그인 기능 구현

4. 템플릿으로 이슈 작성


Projects 와 Milestone 은 미리 등록해놓아야 설정 가능함

이슈를 만들면 이슈 번호가 주어짐!

🏂 Project(칸반보드) 생성

Organizations 이나 개인의 프로젝트를 나타냄

2023-shook 프로젝트의 칸반보드를 make copy 해서 개인 칸반보드를 생성

아까 만든 이슈에서 칸반보드 설정을 넣어주어 표시되도록 함

🪨 Milestone 생성

마일드스톤은 프로젝트 이슈 탭에서 생성가능

마일스톤으로 등록하면 관련 이슈와 진행도를 한 눈에 확인이 가능!
보통 큰 작업 개념이나 version 을 등록

아까 생성한 이슈에서 마일드스톤 설정을 넣어주어 표시되도록 함


✚ 이슈 하나더 생성



생성 후 이슈 Status 설정가능

👨‍🔬 하나의 마일드스톤(큰 작업)에 두개의 이슈 생성 완료


👍 일반적으로 개발 프로세스에서 각각의 이슈에 대해 별도의 브랜치를 생성하여 작업하는 것이 일반적임!
작업 흐름:
1. 이슈를 선택하고 해당 이슈 번호로 새로운 브랜치를 생성.
ex) feat/{issue-number}-{feature-name}
feature/#123-implement-new-feature
2. 해당 브랜치에서 작업을 수행하고 변경사항을 커밋.
3. 작업이 완료되면 원격 저장소로 push하고, 이슈에 대한 작업이 끝났음을 나타내기 위해 pull request를 생성.
4. pull request는 코드 리뷰와 테스트를 거쳐 메인 브랜치에 병합.

🕊️ IntelliJ Task로 Issue 브렌치 생성하기

😁 인텔리제이에서는 레포지토리에 존재하는 이슈로 브랜치를 생성하는 기능을 제공하고 있음.

1. IntelliJ - Tasks 연동

인텔리제이의 Preferences 를 들어간 후 Tools > Tasks > Server에서 + 버튼을 누르고 Github 와 연동 , 정보를 입력하고 토큰을 발행해야함

2. 브렌치 생성

원래는 Dev 브렌치에서 파야하지만 Main을 Dev라고 가정하고 진행
인텔리제이 우상단 Default task 영역을 클릭 후, Open Task...를 클릭하면 아까 만들어 놓은 이슈를 확인가능!
(프로젝트이름)-(이슈번호):(이슈이름)


브랜치명(Create branch)을 명명 규칙에 맞게 수정하고 OK버튼을 클릭

Default Task는 위에서 Create changelist에 등록한 이름으로 바뀌었고 terminal 에서 브렌치 생성 확인 가능

🫸 인텔리제이에서 커밋, 푸쉬

feat/#1-이슈테스트1 브렌치에서 2개의 커밋을 만들고 push 해줌

1. 오른쪽 하단에서 내 현재 브렌치 확인❗️
2. ~ 작업 ~
3. 왼쪽의 상단 세로의 Commit 버튼을 누르고 커밋. (Commit and Push 하여 Remote에도 바로 적용가능)

깃허브에서도 확인가능
사실 커밋 메세지도 아래와 같이 컨벤션을 맞춰줘야함 , 여기서는 그냥 테스트진행

Feat: "Add login API"        // 타입: 제목

로그인 API 개발               // 본문

Resolves: #123              // 꼬리말 => 이슈 123을 해결했으며,
Ref: #456                                 이슈 456 를 참고해야하며,
Related to: #48, #45         현재 커밋에서 아직 이슈 48 과 45 가 해결되지 않았다.

📤 Pull request 생성

PR 템블릿은 따로 생성 해줘야함
참고 : Github - Pull request template 작성과 설정

Github에서 PR 탭 클릭하여 PR생성
🤬 브렌치가 어디서 어디로 합쳐지는지 꼭 잘 확인해야함!!


PR도 이슈처럼 내용을 작성해주고 Assigners, labels, projects, milestone 를 넣어줄 수 있음 + Reviewer
연관된 이슈 번호를 입력하여 추적 가능

PR을 받은 사람은 해당 브렌치의 커밋 코드 및 컨벤션을 점검하고 Merge함 , Merge 후에는 브렌치를 삭제 할 수 있음


프로젝트 칸반보드에서도 확인가능

profile
💪 점진적 과부하로 성장하는 개발자

0개의 댓글