지금까지 레포지토리를 단순히 코드를 공유하고, 과제를 클론받는 단순한 원격 코드 저장소로써 사용해왔다면, 프로젝트부터는 하나의 완성도니 개발 프로젝트에 대한 코드와 정보를 공유하는 수단으로 사용해야 한다.
Github 리포지토리에 꼭 필요한 파일
README.md
오픈소스 프로젝트에서 가장 먼저 확인할 수 있는, 마크다운으로 작성된 간단한 소개글
(대체로 어떻게 하면 해당 오픈소스를 활용할 수 있는지에 대한 정보가 소개되어 있다.)
다음은 벨로퍼트(존경합니다)분이 만든 상태관리 라이브러리 sangte의 README파일이다.
(https://github.com/velopert/sangte)
보다시피 installation 방법부터 sangte에 관한 개요가 있음을 알 수 있다.
일반적으로 REAMDME에는 다음과 같은 사항이 포함되어야 한다.
- 프로젝트 이름
- 프로젝트 핵심 기능 소개
- 팀원 소개
.gitignore
git으로 관리하지 않는 파일 모음(개인이 따로 관리해야하는 secret token, AWS 비밀 키, JWT 비밀 키 , 공유할 필요가 없는 설정파일 등). git이 이를 파악해 push할 때 github 레포지토리에 push되지 않는다.
다음은 마찬가지로 sangte의 gitignore파일이다.
루트 디렉토리에 파일을 생성한다. 터미널로도 파일을 생성할 수 있다.
touch .gitignore
아니면 사이트에서 gitignore의 내용을 쉽게 생성할 수 있다.
https://www.toptal.com/developers/gitignore
LICENSE
해당 코드의 라이센스를 표기한다.
public하게 공개된 레포지토리일지라도 라이센스에 따라 사용할 수 있는지 여부가 갈린다. 회사에서 사용하는 코드는 private으로 관리해 외부에 공개되지 않아 라이센스 정보를 따로 표기하지 않는다.(물론 public으로 바꿀거면 써야하고)
프로젝트 관리에 활용할 수 있는 Github 기능
Issue
말 그대로 새로운 기능을 제안하거나, 버그를 제보하는 등
프로젝트에서 생기는 이슈
이슈의 템플릿을 만들 수도 있다.
-
레포지토리의 setting탭을 살펴보면 Issues 부분에 Set up templates 클릭
-
Custom template를 선택하고 진행
template 이름, 설명, content 내용 작성
-
작성 완료후 레포지토리에 템플릿 등록을 위해 commit 진행
-
레포지토리에 템플릿이 잘 올라간 걸 확인
-
Issues 탭에서 템플릿이 잘 등록된걸 확인한다.
- 또한 이슈가 무엇에 관한 것인지 label 을 지정할 수 있다.
Milestone
Milestone은 이정표 역할을 하며, 태스크 카드(즉, Issue)를 그룹화하는데 사용한다. 연결된 Issue가 종료되면 Milestone마다 진행상황이 업데이트 된다.
해당 기능을 이용하면 이슈의 추적과 진행상황을 한눈에 파악할 수 있다
= 유사한 이슈들을 모아 일정관리를 할 수 있다.
Pull Request
내가 작업한 내용을 중요 git branch에 합칠 수 있는지 확인하는 요청.
깃헙에서는 Pull Request에서 커밋한 코드를 따로 선택해 코멘트를 달 수 있다. 현장에서도 자주 쓰이기 때문에 매우 중요하다.
Project
깃헙 내에서 업무관리를 해줄 수 있게 돕는 새로운 기능
