[GitHub] GitHub Repository

박두팔이·2023년 4월 12일
0

깃허브

목록 보기
2/3

GitHub Repository로 하나의 개발 프로젝트에 대한 코드와 주요 정보를 공유하는 방법!


1. GitHub Repository에 꼭 필요한 파일

1️⃣ README.md

GitHub는 개발자들의 SNS라고 불릴 정도로 다양한 종류의 오픈소스 프로젝트가 공유되어 있다. 기본적인 마크다운 사용법을 잘 숙지하고 있으면 간단한 소개 페이지 처럼 제작할 수 있다. 양식은 따로 존재하지 않다. 대체로 활용방법에 대한 상세한 정보가 작성되어 있다.

2️⃣ .gitignore

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

  • 개인이 관리해야하는 중요한 secret token
  • 다른 동료들과 공유할 필요가 없는 설정파일
  • 그 외 공유할 필요 없는 파일

등이 여기에 속하며 .gitignore에 파일을 기록하면 git이 이를 파악하지 않고 push할 때 github Repository에 push되지 않는다.

3️⃣ LICENSE

GitHub에 public하게 공개된 repository도 라이센스에 따라서 사용범위가 달라진다. 회사에서 사용하는 코드는 대부분 private로 관리하고 외부에 공개하지 않기 때문에 라이센스를 표기하지 않아도 되지만 사내 코드가 public으로 공개된다면 라이센스를 명확하게 표기해야한다.


2. 프로젝트 관리에 활용할 수 있는 GitHub기능

1️⃣ Issue

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

2️⃣ Milestone

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

3️⃣ Pull Request

  • 내가 작업한 내용을 중요 Git branch에 합칠 수 있는지 확인하는 요청이다.
  • GitHub에서는 Pull Request에서 커밋한 코드를 따로 선택하여 해당 부분에 코멘트를 달 수 있다.
  • Pull Request를 보고 코멘트를 남기면서 코드 리뷰를 진행하기 때문에 Pull Request 과정에 익숙해지는 것이 중요하다.

4️⃣ Project

깃허브 프로젝트는 깃허브 내에서 업무 (흐름을)관리를 해줄 수 있게 돕는 새로운 기능이다.

profile
기억을 위한 기록 :>

0개의 댓글