⭐ `GitHub` 사용법

[HyungJinHan]

⭐ 무조건 외울 필요는 없으며, 필요한 정보만 찾아서 사용하기를 권장 ⭐

0번 내용의 경우 정독 권장

---

0. 프로젝트 관리

0.1. 해당 프로젝트의 Repository Clone 방법

1. VS Code 실행 후, GitHub와 연동

2. 키보드 F1 입력 후, 상단의 검색 창의 Git: 복제하다 클릭

3. GitHub에서 복제 클릭

4. Clone 할 Repository를 찾은 후, 클릭하여 원하는 위치에 Repository의 복제본 저장

0.2. Branch 활용 (팀원) ⭐

1. 해당 프로젝트의 Repository Clone (VS Code 사용)

2. Clone한 레포지토리를 수정, 코딩 작업 진행

3. 원하는 이름으로 branch를 만들고 해당 branch로 commit (main 또는 master branch 사용 X) ⭐

4. commit 시에는 메세지 입력란에 반드시 메세지를 입력할 것

5. 변경 내용 동기화 실시

6. 소스 제어 리포지토리의 해당 프로젝트의 Git 아이콘인 Create Pull Request 클릭

7. 생성된 branch를 MERGE CHANGES FROM로 INTO는 main으로 한 후, title, comment에 수정 내용 작성 후 create

8. 경고창으로 뜨는 Publish Branch 클릭으로 branch 게시 및 Pull Request 실행

9. 이후의 모든 작업 및 동기화는 위의 내용을 반복하며 진행

• VS Code를 통한 Pull Request 작업에 대해 오류가 날 수 있으니, 각별한 주의가 필요

• commit → 분기 게시 → Pull Request, Pull Request 후의 안내에 따른 commit 및 분기 게시 테스트 결과 오류 X

• 작업자 등록 오류가 뜰 시, cmd에 code --no-sandbox 입력

0.3. 각각의 branch merge (팀장)

1. Pull Request를 통해 수정된 사항 확인 후, 문제가 없다면 merge 실시

2. merge 실시 후, 변경 내용 동기화를 통해 변경 내용 확인

3. 팀원의 이름으로 만들어진 branch를 삭제하여 Pull Request 완료

4. 이후, 팀원끼리의 작업 동기화는 위의 내용을 반복하며 진행, 팀원에게 변경된 내용 고지

---

1. 간단한 Git 사용법

Git 설치

• Git 설치 및 연동 방법

  2. 마크다운 사용법(문법)

  2.1. 헤더Headers

• 큰제목: 문서 제목

  This is an H1
  =============

  This is an H1

• 작은제목: 문서 부제목

  This is an H2
  -------------

  This is an H2

• 글머리: 1~6까지만 지원

  # This is a H1
  ## This is a H2
  ### This is a H3
  #### This is a H4
  ##### This is a H5
  ###### This is a H6

  This is a H1

  This is a H2

  This is a H3

  This is a H4

  This is a H5

  This is a H6

  ####### This is a H7(지원하지 않음)

2.2. BlockQuote

이메일에서 사용하는 > 블럭인용문자를 이용한다.

> This is a first blockqute.
>   > This is a second blockqute.
>   >   > This is a third blockqute.

This is a first blockqute.

This is a second blockqute.

This is a third blockqute.

이 안에서는 다른 마크다운 요소를 포함할 수 있다.

This is a H3

• List

  code

2.3. 목록

● 순서있는 목록(번호)

순서있는 목록은 숫자와 점을 사용한다.

1. 첫번째
2. 두번째
3. 세번째

1. 첫번째
2. 두번째
3. 세번째

현재까지는 어떤 번호를 입력해도 순서는 내림차순으로 정의된다.

1. 첫번째
3. 세번째
2. 두번째

1. 첫번째
2. 세번째
3. 두번째

딱히 개선될 것 같지는 않다. 존 그루버가 신경안쓰고 있다고...

● 순서없는 목록(글머리 기호: *, +, - 지원)

* 빨강
  * 녹색
    * 파랑

+ 빨강
  + 녹색
    + 파랑

- 빨강
  - 녹색
    - 파랑

• 빨강

  • 녹색
  • 파랑

• 빨강

  • 녹색
  • 파랑

• 빨강

  • 녹색
  • 파랑

혼합해서 사용하는 것도 가능하다(내가 선호하는 방식)

* 1단계
  - 2단계
    + 3단계
      + 4단계

• 1단계
  • 2단계
  • 3단계
    • 4단계

2.4. 코드

4개의 공백 또는 하나의 탭으로 들여쓰기를 만나면 변환되기 시작하여 들여쓰지 않은 행을 만날때까지 변환이 계속된다.

2.4.1. 들여쓰기

This is a normal paragraph:

    This is a code block.

end code block.

실제로 적용해보면,

적용예:

---

This is a normal paragraph:

This is a code block.

end code block.

---

한줄 띄어쓰지 않으면 인식이 제대로 안되는 문제가 발생합니다.

This is a normal paragraph:
    This is a code block.
end code block.

적용예:

---

This is a normal paragraph: This is a code block. end code block.

---

2.4.1. 코드블럭

코드블럭은 다음과 같이 2가지 방식을 사용할 수 있습니다:

• <pre><code>{code}</code></pre> 이용방식

<pre>
<code>
public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }

}
</code>
</pre>

public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }
}

• 코드블럭코드("```") 을 이용하는 방법

```
public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }
}
```

public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }
}

깃헙에서는 코드블럭코드("```") 시작점에 사용하는 언어를 선언하여 문법강조(Syntax highlighting)이 가능하다.

```java
public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }
}
```

public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }
}

2.5. 수평선 <hr/>

아래 줄은 모두 수평선을 만든다. 마크다운 문서를 미리보기로 출력할 때 페이지 나누기 용도로 많이 사용한다.

* * *

***

*****

- - -

---------------------------------------

• 적용예
• • *

---

---

---

---

2.6. 링크

• 참조링크

[link keyword][id]

[id]: URL "Optional Title here"

// code
Link: [Google][googlelink]

[googlelink]: https://google.com "Go google"

Link: Google

• 외부링크

  사용문법: [Title](link)
  적용예: [Google](https://google.com, "google link")

  Link: Google

• 자동연결

  
  일반적인 URL 혹은 이메일주소인 경우 적절한 형식으로 링크를 형성한다.

• 외부링크: http://example.com/

• 이메일링크: address@example.com

• 외부링크: http://example.com/

• 이메일링크: address@example.com

2.7. 강조

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
~~cancelline~~

• single asterisks
• single underscores
• double asterisks
• double underscores
• cancelline

문장 중간에 사용할 경우에는 **띄어쓰기** 를 사용하는 것이 좋다.
문장 중간에 사용할 경우에는 띄어쓰기를 사용하는 것이 좋다.

2.8. 이미지

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

사이즈 조절 기능은 없기 때문에 <img width="" height=""></img>를 이용한다.

예

<img src="/path/to/img.jpg" width="450px" height="300px" title="px(픽셀) 크기 설정" alt="RubberDuck"></img><br/>
<img src="/path/to/img.jpg" width="40%" height="30%" title="px(픽셀) 크기 설정" alt="RubberDuck"></img>

2.9. 줄바꿈

3칸 이상 띄어쓰기( )를 하면 줄이 바뀐다.

* 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다. 
이렇게

* 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다.___\\ 띄어쓰기
이렇게

• 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다. 이렇게

• 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다. \ 이렇게