Github 리포지토리에 필요한 요소

🌐 Github 리포지토리에 꼭 필요한 파일

 

README.md

Pre-Project Github 리포지토리 README.md 파일은 아래 정보를 꼭 포함해야 한다.

• 프로젝트 이름
• 프로젝트 핵심 기능 소개
• 팀원 소개

 

.gitignore

gitignore dotfile은 git으로 관리하지 않는 파일 모음이다.

여기에는 개인이 따로 관리해야 하는 중요한 secret token이나, 다른 동료와 공유할 필요가 없는 설정 파일, 그 외 공유할 필요 없는 파일을 기록하면 git이 이것을 파악하지 않고, push 할 때도 github 리포지토리에 push되지 않는다.

 

LICENSE

해당 코드의 라이센스를 표기합니다. 깃허브에 public하게 공개된 리포지토리도 라이센스에 따라서 사용을 할 수도 있고, 하지 못 할 수도 있으니 사용할 때 라이센스를 잘 보고 사용해야 한다. 코드가 public으로 공개된다면, LICENSE를 명확하게 표기해야 한다.

 

---

 

🌐 프로젝트 관리에 활용할 수 있는 Github 기능

 

Issue

Issue는 프로젝트에 새로운 기능을 제안하거나, 버그를 찾아 제보하는 등 프로젝트의 이슈를 말한다.

Pre-Project에서는 Issue를 하나의 칸반 티켓처럼 사용한다.

 

Milestone

Milestone은 이정표 역할을 한다.

태스크 카드(Issue)를 그룹화하는 데 사용한다.

Milestone에 연결된 태스크 카드(Issue)가 종료되면 Milestone마다 진행 상황이 업데이트되는 것을 볼 수 있다. Milestone 기능을 통해 연관된 이슈의 추적과 진행 상황을 한눈에 파악할 수 있는 장점이 있다.

Pre-Project에서는 Bare Minimum, Advanced Challenge, Nightmare를 표시하기 위해 사용한다.

 

Pull Request

Pull Request는 내가 작업한 내용을 중요 git branch에 합칠 수 있는지 확인하는 요청이다.

Pull Request에서 커밋한 코드를 따로 선택하여 해당 부분에 코멘트를 달 수 있다.

 

Project

Project는 Github 내에서 업무 관리를 해줄 수 있게 돕는 새로운 기능.

Project 기능을 이용하여 칸반 보드를 생성하고, 칸반으로 Pre-Project의 업무 흐름을 관리한다.

 

---

🌐  Github repository 만들기

 

1. Github 홈페이지로 이동해서 리포지토리 탭 왼쪽 상단의 New  버튼 클릭

2. 리포지토리 네임은 로컬 리포지토리 디렉토리 이름과 같게 설정하는 것이 좋다.

3. public / private 여부를 체크한다.

4. 옵션)

• Add a README file -  README.md 파일을 자동으로 생성한다.
• Add .gitignore - .gitignore 파일을 자동으로 생성한다.

 

 

로컬 리포지토리에서 작업하기

 

Git Clone

Github 리포지토리를 생성하고, 해당 리포지토리를 로컬로 clone 받아온다.

git clone <git 주소>
cd <디렉터리명>

 

README.md

 

로컬 리포지토리에 [README.md] 파일을 추가하는 방법

touch README.md