깃헙 사용법 및 컨벤션 설명

[chaeyoon-lee-rae]

🔧깃헙 기능 간단 설명

Issue, PR, Project, Discussion

Issue

• 숙제 업로드 / 개발을 진행하면서 고쳐야할 버그나 개선점 작성
• PR과 함께 사용됨
• Sub-issue
  • 팀장: 팀 Sub-issue 만들기
  • 팀원: 팀 Sub-issue에 과제 PR 연결하기

Labels

• PR과 Discussion에도 동일하게 적용됨
• Sorting을 위해서 앞에 숫자 붙힘
  • 0: 공지 또는 과제
  • 1: 엔진 개발 관련 (코어 개발 중심)
  • 2: 그 외 개발 및 자료 조사
  • 3: 문서화 및 생산성 관련
• Label은 얼마든지 수정 가능
• 필터링할 때 유용하게 쓰일 것

Type

• Bug: 버그
• Feature: 개선점 및 기능
• Task: 해야할 일 (과제 등)

Project

• RealTimePathtracer 연결
  • Status(required): Todo or In Progress
  • Priority(required)
    • Assignment: 과제
    • P0: 1~2주 안에 해결해야함
    • P1: 그보다 더 걸려도 됨
  • Teams(optional): 해당 이슈가 특정 팀에 해당한다면 설정
  • Start date, End date(required)

Milestone

• 프로젝트에서 Deadline을 보기 위함

Relationships

• 부모 Issue 지정 가능
• Create sub-issue 버튼으로 자식 Issue 생성 가능

Development

• 해당 이슈를 해결하는 PR 연결
• 여러 개 연결 가능
• PR들이 모두 Closed되면 해당 이슈도 자동으로 Closed됨

Pull Request

• 숙제 제출 / 코드 변경 사항 리뷰 및 병합 요청
  • 어떻게 과제 해결했는지 공유
• Draft PR
  • Review할 준비는 안되어 있지만
  • 미리 생성하여 기록하고 싶을 때나
  • Commit 내역들을 실시간으로 보여주고 싶을 때 사용
  • Review 준비가 되면 그 때 전환
• 팀장이랑 소통하고 나서 팀장이 Approve한다면 merge 진행
  • PR이 close되면 연결된 Issue 자동으로 close
  • Sub-issue들이 모두 close되면 Parent issue에 100% 완료가 뜰 것임

Reviewers

• 과제: 팀 리더에게 요청
• 일반 PR?

Development

• 해당 이슈 연결하기

Branch 구조 예시

main
├── 팀1 branch (team-AAA)
│   ├── 팀원1 branch (team-AAA-chaeyoon)
│   │   └── 과제1 branch (team-AAA-chaeyoon-assign1)
│   └── 팀원2 branch
│       └── 과제1 branch
├── 팀2 branch
└── 팀3 branch

• 과제 PR: 과제 branch -> 팀원 branch
• 통합 제출 PR(한길님 확인용): 팀원 branch -> 팀 branch
  • 어떤 코드를 제출할지는 팀끼리 정하기

Projects

• 여러 레포에 연결시켜서 모든 Issue와 PR, Task 등을 관리할 수 있음

Issue Board

• 팀이 설정되어 있지 않은 general한 이슈 보드
• Cloased된 이슈는 자동으로 Done 섹션으로 옮겨짐

Issue Roadmap

• 이슈 보드를 타임라인 뷰로 보는 것
• Start Date와 End Date를 지정해야지 보임
• Markers: milestone으로 지정함, 목표 날짜 개념

팀별 Roadmap

• 각 팀별로 지정된 Issue나 PR이 보임
• Add item -> Draft
  • 실제 이슈 작성하기 전 아이디어나 할 일 적는 용도로 good

Discussion

Share and Discuss

• Ideas
  • 프로젝트 관련 아이디어나 문제 해결 방법 등 공유하고 싶은 것
• Q&A
  • 프로젝트 진행 및 개발 관련해서 궁금한 거 질문
  • 답변 채택 가능
• Suggestion
  • GitHub 내 Discussion, Issue, PR, 문서화 등에 대한 개선 의견 제안

Issue & PR Template

• bug_report
• feature_request
• pull_request

💁🏻‍♀️Team Convention

Access 권한

• 팀원: Write (코드 push, PR 생성 가능)
• 리더: Maintain (Write 권한 + PR 승인 및 머지, 보호된 브랜치 관리 가능)

과제 진행함에 있어서...

1. 과제 Issue에 각 팀별로 Sub-issue 파기
2. Sub-issue에 진행 사항들 적기
3. 팀원들은 과제 완료 후 원격 저장소로 push
4. PR Template에 따라 작성하여 PR 생성
5. 리더에게 리뷰 요청
6. 해당 Sub-issue에 PR 연결

branch 이름 컨벤션

• team-(팀이름)-(내 이름)-(브랜치 목적)
• ex. team-AAA-chaeyoon-fix-bug
• 더 좋은 아이디어 있다면...

문서화

• 기본적인 소통은 디스코드에서
• 팀 별로 시간을 지정하고 팀 채팅에서 정리해야할 정보는 깃헙에 정리
  • 이슈 사항 -> Issues
  • 공유 사항 -> Discussion
• 그 외 전체 채팅에서도 자유롭게 소통
  • 정기적으로 정리 요청하겠음

💚깃헙 문서화 팁

• # 을 누르면 참조할 수 있는 Issue나 PR, Discussion의 목록이 나옴
  • ex. [Assignment-1] Vulkan 기본 구조 이해 및 실습 과제 #8
• 코드 블록 추가

build-up-phase/dx12-basic-triangle/main.cpp

Lines 3 to 7 in bf6d9b5

	#include <d3d12.h>
	#include <d3dcompiler.h>
	#include <dxgi1_6.h>
	#include <stdio.h>
	#include <tuple>