13. GitHub 잘 사용하기

최준영·2022년 2월 16일
0

Git & GitHub

목록 보기
11/13
post-custom-banner

1. 프로젝트와 폴더에 대한 문서

README.md를 활용한 문서화

  • 예시
  • 프로젝트에 대한 설명이 적혀있는 마크다운 문서이다.
  • 해당 폴더가 어떤 폴더인지 나타내기 위해 폴더별로 만들어도 무방하다.

2. 풀 리퀘스트와 이슈, projects

1) Pull request

  • 변경사항을 merge하기 전 리뷰를 거치기 위해 존재한다.
  • 팀원들의 동의를 거친 뒤 대상 브랜치에 적용한다.
  • 절차
    1. 새로운 브랜치를 생성 후 변경사항을 커밋, 푸시한다.
    2. GitHub 레포 페이지에서 Compare & pull request 클릭
      • 또는 ~branches에서 New Pull request 클릭
    3. 메시지 작성 후 Create pull request 클릭
    4. 팀원이 대상 Pull request의 내용 검토
      • 의견이 있을 시 코멘트 달기
      • 반려해야 할 시 Close pull request
      • 승인할 시 Merge pull request

2) Issue

  • 버그나 문제 제보, 추가할 기능 등의 이슈 소통
  • 예시
  • 절차
    1. GitHub 레포 페이지에서 Issues 탭 클릭
    2. 이슈 작성. 필요시 label, milestone, asignee(책임자) 지정
      • milestone : 이슈의 주제 묶음(특정 목표 등)
    3. 이슈 확인 후 처리
      • 코멘트 달기
      • 관련 개발 착수(브랜치 명이나 커밋 footer에 이슈 번호 반영)
      • 해결 뒤 Close issue

3) Projects

출처 : https://devlog-wjdrbs96.tistory.com/227

  • 프로젝트는 작업 현황과 진행도를 볼 수 있는 메뉴이다. 이슈, PR,들을 하나의 작업으로 분류해 그 작업이 어느 정도 진행되었는지 확인할 수 있다.
  • To do, In Progress, Done과 같은 기능을 통해 프로젝트의 진행 상황을 한번에 파악하기가 수월하다.
    • To do : 해야 할 작업
    • In Progress : 진행 중인 작업
    • Done : 완료된 작업

3. 오픈소스에 참여하기

프로젝트별 참여 가이드를 확인

  • 절차
    1. 해당 프로젝트를 fork한다.
    2. 코드를 수정하고 pull request
    3. 오픈소스 주인이 PR을 코멘트/반려/수락 할 수 있다.
      • 수락되면 해당 오픈소스에 기여한 것이다.

4. GitHub에 블로그 만들기

  • 깃허브 공식 설명
  • 계정별 무로 웹 호스팅이 가능하다.
  • 절차
    1. 레포를 생성하고 로컬로 클론
      • 레포 명 : (내 아이디).gitHub.io로 짓는다.
    2. html 코드 작성
    3. https://(내 아이디).gitHub.io에서 사이트 확인
      • 시간이 어느정도 걸린다.
profile
do for me
post-custom-banner

0개의 댓글