[프로젝트] 프로젝트 준비 - Github 사용법

Jade·2022년 12월 16일
2

프로젝트

목록 보기
5/28

Github 사용법

❗️ github repository 필수 파일

README.md

프로젝트에 대한 소개 페이지로 파일 양식은 따로 존재하지 않음.
오픈 소스 프로젝트인 경우 대체로 어떻게 해당 오픈소스를 활용할 수 있는지가 작성되어 있다.
프로젝트 이름, 프로젝트 핵심 기능 소개, 팀원 소개 등이 들어가면 좋다.

.gitignore

git으로 관리하지 않는 파일을 적어두는 곳으로 주로 보안상 중요한 .env 파일이나, secrect token, 다른 동료와 공유할 필요가 없는 설정 파일, 그 외 공유할 필요 없는 파이들을 기록하면 git이 이를 파악하지 않고, push 할 때도 github 리포지토리에 push 되지 않는다.

LICENSE

해당 코드의 라이센스를 표기하는 파일.
라이센스에 대한 기사

SW 라이센스의 유형에는 여러가지가 있는데 깃허브에 public으로 공개된 레포지토리라도 라이센스에 따라서 사용을 할 수도 있고, 하지 못할 수도 있기 때문에 라이센스를 잘 보고 사용해야 한다고 한다.

사실 아직 회사에 다녀본 적도 없고, 오픈 소스 라이브러리에 기여한 적도 없어서 SW 라이센스가 뭔지 무지했는데, 위 기사를 읽어보며 여러가지 라이센스가 존재하고, 오픈소스이더라도 여러가지 제한 사항이 존재할 수 있다는 점을 알 수 있었다.



❗️ 프로젝트 관리에 활용할 수 있는 github 기능

Issue

프로젝트에 새로운 기능을 제안하거나 버그를 찾아 제보하는 등 프로젝트에 대한 '이슈'를 의미하는데,
칸반 티켓처럼 사용할 수도 있다. (티켓은 칸반 안에 들어가는 하나의 task? 같은 느낌인듯)

칸반
업무 관리 방법 중 하나로 팀과 조직이 작업을 시각화하는 것을 돕는다.
업무의 병목 현상이나 리소스 낭비를 해결하는 데도 좋다.

현재 진행하고 있는 사이드 프로젝트에서도 칸반 방식을 사용하고 있다고 할 수 있을 것 같은데,
위의 이미지는 노션의 보드를 사용한 칸반이다.

노션을 사용할 수도 있겠지만, 깃허브에서 제공하는 Issue, Milestone, Project 기능을 잘 활용하면 깃허브로도 칸반 제작이 가능하다.

Milestone

마일스톤은 이정표 역할을 하며, 태스크 카드(issue)를 그룹화하는 데 사용할 수 있다.
Milestone에 연결된 Issue가 종료되면 진행 상황이 업데이트 되는 것을 볼 수 있다.

Bare Minimum에 들어있던 Issue가 close 되니까 complete bar가 올라간 것을 볼 수 있음!

Pull Request

pull request를 이용하면 내가 작업한 내용을 중요 git branch에 합칠 수 있는지 요청을 넣을 수 있다.
Githubdptjsms Pull Request에서 커밋한 코드를 따로 선택해 해당 부분에 코멘트를 달 수 있으므로 현장에서도 코드 리뷰를 진행한다고 한다.

Project

Github 내에서 업무 관리를 해줄 수 있게 돕는 새로운 기능.
노션 보드처럼 볼 수도 있고, List 형식으로도 볼 수 있다.

profile
키보드로 그려내는 일

0개의 댓글