[GitHub] GitHub 사용법

Index

1. GitHub 회원가입 및 로그인

2. Remote Repository 생성 및 Local Repository 연동하기

3. GitHub Shortcuts

4. Project

5. Issue

6. Pull Requeset

7. Wiki

Reference

---

1.  GitHub 회원가입 및 로그인

1. GitHub 접속

2. 위측 상단의 회원가입(Sign up) 및 로그인(Sign in) 클릭

 

2.  Remote Repository 생성 및 Local Repository와 연동하기

1. GitHub 페이지의 New 버튼 혹은 Repository의 New 버튼 클릭

 

2. Repository 생성 페이지 입력 후 Create repository 버튼 클릭

- Repository name: 저장소 이름

- Description: 저장소 설명

- Public / Private: 공개 / 비공개 선택

 

3. Remote Repository 생성 후 Local Repository 연동

1) Local에 새 폴더 생성

2) 생성한 폴더에 진입후 붉은 색 상자 명령어 순서대로 입력

- echo "# test" >> README.md : 파일이 없다면 "# test"를 입력한 README.md 파일 생성.

- git init: git 저장소 초기화

- git add README.md: README.md 파일 업로드 등록

- git commit -m <commit message>: <commit messege>라는 기록 남기기

- git branch -M <브랜치명>: 메인 브랜치를 <브랜치명>이라는 이름으로 설정

- git remote add <변수명> <원격저장소 url>: <변수명>에 <원격저장소 url> 등록 

- git push -U <변수명> <브랜치명>: <변수명>에 등록된 원격저장소 url에 <브랜치명>의 등록된 파일, 폴더 업로드

 

<상세 설정> :  window의 경우 git bash나 cmder 이용

1) Local에서 폴더 생성

- mkdir 폴더명 / 마우스 우클릭 새폴더 선택

2) 생성한 폴더내 진입

- cd 폴더명 / 폴더 더블 클릭

3) git init으로 해당 폴더 초기화(.git 폴더 생성)

  - ls -al명령어로 .git 폴더 생성 확인

4) git remote add origin <remote repository url>

  - origin 변수에 remote repository url 등록,

  - git remote -v로 변수명에 등록된 remote repository url 확인

  - git remote remove

  - git remote rename <원본 변수명> <변경할 변수명>

5) .gitignore 파일 생성(업로드시 제외할 폴더, 파일 목록)

  - .gitignore, **/.DS_Store

6) README.md 파일 생성후 내용 편집(Remote Repository에 표시될 내용)

  - Markdown 문법 사용

7) git add 명령어로 업로드할 파일, 폴더 등록

  - git add <폴더/파일>: .(dot)으로 해당 경로의 모든 폴더 파일 등록 가능, wild card 사용

8) git status로 업로드 상태 확인

9) git commit으로 메시지 입력

  - git commit -m <commit message>: 한 줄 입력

  - git commit --amend: 커밋 메시지 수정

  - git log: 이전 커밋 메시지들 확인

  - git commit message 양식에 맞게 입력 추천: feat, fix, refactor, issue

10) git push -U <변수명> <브랜치명>: 

  - <변수명>에 등록된 원격저장소 url에 <브랜치명>의 등록된 파일, 폴더 업로드

11) git add 되돌리기

  - git reset --mixed HEAD^

12) git commit 되돌리기

  - git reset --soft HEAD^

13) 변경된 파일 생성 전으로 되돌리기(삭제)

- git reset --hard HEAD^

14) git clean으로 추적되지 않은 파일 제거

  - -d 옵션: 폴더까지 제거

  - -x 옵션: .gitignore에 등록된 파일까지 제거

  - -n 옵션: 가상 실행후 삭제될 파일을 보여줌. 실제로 삭제되지 않음

15) git log로 커밋 메시지 기록 확인

16) git reflog로 로컬 저장소의 HEAD 업데이트 기록을 출력

  - .git/logs/heads에 기록됨

 

4. 연동 확인

- Repository 생성 확인

 

 

 

3.  GitHub Shortcuts

 

1) 서치바(Find Mode): /

2) Find Finder: T

3) Command Pallette: cmd + K -> /(File Finder), #(Issues, Pull Requests,...), >(Command Mode)

4) Command Toggle: i

5) 해당 줄로 이동(Jump to a Line): L

6) Git Blame: B

7) 단축키 확인: ?

8) 소스코드 클릭 후 복사(해당 링크 강조): Y

 

4. Project

Project란?

- 작업의 진행도를 한눈에 볼 수 있고, 이슈들을 하나의 task(작업)로 나타내서 작업의 진행도를 확인 및 관리하는 메뉴

 

1. Remote Repository 내의 Projects 탭 클릭

- Link a project를 New Project로 변경 후 클릭

 

2. 필요한 templates 검색 후 클릭(Team Planning, Kanban)

 

3. Project name 항목에 프로젝트명 입력 후  Create project 클릭

4)

4. 생성된 프로젝트 확인

(Team Planning)

- Todo: 모든 Issue, 해야할 것, 새로운 기능 및 기능 수정, 모든 Pull Request

- In Progress: 새로 열린 Pull Request, Issue

- Done: close된 Issue, Merge된 Pull Request

 

 

 

5.  Issue

Issue란?

- 프로젝트의 기획, 작업, 개선 사항, 버그 수정, 새로 추가될 기능 등 모든 것을 Issue라고 함

- GitHub에서 이러한 활동에 대해 이슈 등록후, 작업을 진행

 

1. Label 확인 및 추가 생성

- Remote Repository의 Issue 탭 선택 후 Labels 클릭

 

- New label 클릭 -> Label name, Description, Color 입력 후 Create lable 클릭

 

2. Issue 생성

- Remote Repository의 Issue 탭 선택 후 New Issue 클릭

 

3. Issue 내용 입력 후 Submit new issue 클릭

- Title: Issue의 제목 설정

- Description: Issue 내용 입력

-  Assigness: 이슈 해결을 위한 담당자

- Labels: 작업의 유형, 성격

- Project: 등록할 프로젝트 설정

- Milestone: 프로젝트가 도달해야하는 목표지점, 한 가지의 목표에 여러 이슈 등록시 해당 목표의 진행도를 게이지 바 형태로 볼 수 있음.

 

+) .github 폴더에 issue_template.md 생성: Issue 생성시 양식 자동 생성

 

 

name: 템플릿 이름
about: 템플릿 설명
title: 기본 title
labels: 기본 labels
assignees: 기본 assignee (GitHub Username을 적어줍니다, 기본 설정을 원치 않으면 '' 공백으로 설정합니다.)

 

6. Pull Reqeust

1. Remote Repository의 Pull requests 탭 클릭 후 New pull request 클릭

- merge할 branch 가 없으면 좌측 하단의 이미지와 같이 나타남

- merge할 branch가 있다면 Compare & pull request가 보임

 

2. compare에서 base로 branch 병합 설정후 Createe pull request 클릭

 

3. 내용 입력 후 Create pull request 클릭

- Title: Pull Request할 제목

- Description: Pull Request에 대한 설명

- Reviewers: 현재 PR를 리뷰해줄 팀원 지정

- Assigness: 현재 PR 작업의 담당자 지정

- Labels: 작업 유형 지정

- Projects: 프로젝트 지정

- Milestone: 기간 지정

 

+) .github 폴더에 pull_request_template.md 생성: Pull Request 생성시 양식 자동 생성

 

4. 생성된 Pull Request 확인후 선택

 

 

5. Merge pull request 클릭

- Create a merge commit: 

- Squash and merge:

- Rebase and merge: 

 

6. Message 입력 후 Confirm merege 클릭

 

7. merge 후 branch 삭제하려면 Delete branch 클릭

 

8. merge 여부 확인 및 branch 삭제 확인

 

 

 

7.  Wiki

1. Remote Repository 내의 Wiki 탭 선택 후 Create the first page

 

2. Page 편집 후 Save page 클릭

- Title: 제목 작성

- Write: 보여지는 페이지, Markdown 사용

 

3. Wiki 추가 편집

- Edit: 기존 페이지 수정

- New Page: 새로운 페이지 추가, Pages에 목록 추가

- Add a custom footer: footer 등록

- Add a custom  sidebar: sidebar 등록

 

---

Reference