Git을 공부해보자: GitHub 잘 사용하기 (리드미, 풀 리퀘스트, 이슈, 오픈소스)

인프런에서 "제대로 파는 Git & GitHub - by 얄코"를 보고 정리한 내용입니다!

README.md

• 프로젝트 최상위 폴더에 README.md 파일 작성
• 폴더 만들어 폴더별 README.md 만들 수 있음
• VS Code에서 미리 보기 가능

마크다운 문법

• markdownguide.org
• GitHub 제공 가이드

 

풀 리퀘스트와 이슈

Pull request

변경사항을 merge하기 전 리뷰를 거치기 위함

• 팀원들의 동의를 거친 뒤 대상 브랜치에 적용

풀 리퀘스트 사용

1. 새로운 브랜치 생성 후 변경사항 커밋하여 푸시
2. GitHub 레포지토리 페이지에서 Compare & pull request 버튼 클릭
   • 또는 branches에서 New pull request 클릭
3. 메시지 작성 후 Create pull request 클릭

풀 리퀘스트 검토 후 처리

1. GitHub 레포지토리 페이지에서 Pull requests 탭 클릭
2. 대상 풀 리퀘스트 클릭하여 내용 검토
   • 의견이 있을 시 코멘트 달기
   • 반려해야 할 시 Close pull request
   • 승인할 시 Merge pull request

Issue

버그나 문제 제보, 추가할 기능 등의 이슈 소통

이슈 작성

1. GitHub 레포지토리 페이지에서 Issues 탭 클릭
2. 필요시 label 또는 milestone 생성
   • milestone: 이슈의 주제 묶음 (특정 목표 등)
3. 이슈 작성
   • 필요시 label, milestone, asignee 지정
4. 이슈 확인 후 처리
   • 코멘트 달기
   • 관련 개발 착수 (브랜치명이나 커밋 footer에 이슈 번호 반영)
   • 해결 뒤: Close issue

 

오픈소스 프로젝트에 기여

1. 프로젝트 fork (레포지토리 전체를 복사하는 것)
2. 코드 기여하기
   • 코드 수정 후 pull request
3. 오픈소스 주인 관점
   • 풀 리퀘스트 코멘트/반려/수락