프로그래밍/깃&깃허브

[깃&깃허브] 06. 깃허브에서 개발자와 소통하기 (p.202~220)

aSpring 2021. 3. 21. 17:03
728x90
728x90

2021/01/16 - [분류 전체보기] - Do it! 공부단

2021/02/19 - [프로그래밍/깃&깃허브] - [깃&깃허브] 01. 깃 시작하기 (~p.37)

2021/02/20 - [프로그래밍/깃&깃허브] - [깃&깃허브] 02. 깃으로 버전 관리하기 (p.38~83)

2021/02/21 - [프로그래밍/깃&깃허브] - [깃&깃허브] 03. 깃과 브랜치 (p.84~130)

2021/02/22 - [프로그래밍/깃&깃허브] - [깃&깃허브] 04. 깃허브로 백업하기 (p.131~165)

2021/02/23 - [프로그래밍/깃&깃허브] - [깃&깃허브] 05. 깃허브로 협업하기 (p.166~201)

 


 

06 깃허브에서 개발자와 소통하기

깃허브
- 자신이 커밋한 소스를 보여줄 수 있고, 다른 개발자들과 그 소스에 대한 의견을 나눌 수 있는 공간
- README 문서(저장소 소개) 비롯 깃허브에서 해온 활동을 요약해 프로필 관리 -> 다른 개발자들이 내 저장소의 소스를 더 쉽게 파악하고 의견을 줄 수 있음

전 세계의 내로라하는 오픈 소스가 깃허브에 많이 모여 있는데, 저장소마다 여기에 있는 오픈 소스가 무엇인지 쉽게 알려주는 README 문서 등이 있기 때문에 소스를 참고해서 공부하기에도 좋은 곳

<오픈 소스 프로젝트에 참여하면서 깃허브 활동을 풍부하게 만드는 방법>
<깃허브 저장소를 사용해 개인 블로그를 작성하는 방법>

06-1 깃허브 프로필 관리하기

커밋을 꾸준히 쌓아 놓으면 자신이 성실하게 맡은 프로젝트를 관리하고 있다는 것을 보여줄 수 있음
- 이처럼 자신의 개발 이력을 드러낼 수 있는 프로필 관리 방법에 대해 알아보자

프로필 둘러보기

프로필 : 깃허브 프로필을 보고 협업이나 일자리 제안을 받을 수도 있기 때문에 개발자로서 자신의 개발 경력을 드러낼 수 있는 가장 좋은 방법

프로필 작성하기

1. https://github.com/아이디로 접속 > 프로필 사진 클릭
2. [Edit] -> [Upload a photo]        ※ 삭제 [Edit] -> [Remove photo]
3. 사진 선택 후 [열기] -> [Set new profile picture]
4. 그 밖에 공개할 사용자 정보를 추가로 입력하고 [Update profile]
※ 사용자 메일 주소를 프로필에 공개하려면 왼쪽 메뉴 중 Emails를 선택하고, Primary email address에서 메일 선택

[한 걸음 더!] 깃허브 설정 항목
Profile : 프로필 정보 입력/수정
Account : 사용자 이름 변경 / 계정 삭제
Security : 비밀번호 변경 / 이중 인증
Emails : 사용자 메일 주소 추가 / 주 메일 주소와 백업 메일 주소 지정
Notifications : 깃허브에서 알림 받을 방식 지정
Billing : 유료 계정 전환
SSH and GPG keys : SSH 키나 GPG 키 입력
Blocked users : 특정 사용자 차단
Repositiories : 저장소 관리, 필요시 저장소 삭제
Organizations : 속해 있는 조직이 있을 경우 그 조직을 보여주고 조직 선택 가능
Saved replies : 반복해서 작성하는 댓글이 있을 경우 따로 저장해 두고 사용할 수 있음
Applications : 깃허브 앱이나 인증 관련 앱이 나타남
Developer settings : 깃허브와 관련된 개발을 할 때 앱을 등록하고 개발 관련 정보 참고

컨트리뷰션 살펴보기

사용자가 1년 동안 깃허브에서 얼마나 활발하게 활동했는지를 보여주는 곳
- 사용자들 끼리는 '깃허브에 잔디를 심는다'고 표현하기도 함
작은 사각형 하나하나가 하루에 해당, 컨트리뷰션이 있는 날에는 사각형에 초록색이 칠해진다. 진할수록 그날 컨트리뷰션이 많았다는 뜻
- 사용자의 활동 내역을 한 눈에 살펴볼 수 있기 때문에 이력서 같은 역할을 할 수도 있다.
- 컴트리뷰션에는 개인이 작성한 소스 코드를 커밋하는 것이나 오픈 소스 프로젝트에 기여하는 커밋이 모두 포함됨

06-2 README 파일 작성하기

README 파일 만들기

README 파일 : markdown 문법 사용 -> 확장자 .md
https://github.com/kyrieko/html5-book-9 : 다른 책 실습 파일 제공하는 곳
- 목록 아래에 README.me 파일 나타남 : 실습 파일을 내려받는 방법을 설명하고 있음
- 제목, 본문을 다르게 표시, 글씨체 바꾸는 등 여서 서식 적용 가능, 이미지, 외부 링크고 넣을 수 있음

1. README 파일을 만들 깃허브의 저장소로 접속 > [Add a README]

2. 텍스트 편집기에 원하는 내용 입력

- 이 때 줄을 바꾸려면 [Enter]를 두 번 눌러서 가운데 빈 줄을 하나 넣어야 실제 화면에서 줄이 바뀌어 나타남

3. [Edit new file]에서 작성하고 [Preview]를 통해 결과 화면 미리 보기

4. README 파일 커밋하기 : 커밋 메시지 작성 > [Commit new file]

5. 수정 시 연필 아이콘 클릭하여 수정 > [Preview changes] : 미리 보기 화면에서 내용 왼쪽에 초록색 막대가 나타난 부분은 추가된 내용, 빨간색 막대가 나타난 부분은 삭제된 내용

6. 커밋 메시지 작성 > [Commit changes] : 수정한 내용 깃허브에 등록

 

마크다운 문법 알아보기

마크다운 : 사용이 쉽고 HTML 태그에 비해 간단 -> 문서 작성 편리
단 마크다운을 지원하는 프로그램이나 사이트에서만 사용 가능

<깃허브에서 README.md 파일 작성 시 자주 사용하는 마크다운 문법 살펴보기>
※ 자세한 설명 https://help.github.com/en/articles/basic-writing-and-formatting-syntax 참고

1. 제목 : 텍스트 앞에 # 붙이기 (1~6개 까지) -> 글자 크기 정할 수 있으며 #와 문자 사이에 여백 필요

2. 텍스트 단락 줄 바꾸기 : [Enter] 두 번

3. 가로 줄 추가 ----, ----------, - - -, ***, *************, * * * 사용

4. 순서가 있는 목록 : 1, 2, 3 ... 번호 붙임
※ 목록은 항목 전체가 하나의 단락 -> 엔터 한 번만 눌러서 줄 바꿈

5. 순서가 없는 목록 : + - *을 붙여 나열하면 자동으로 글머리 기호가 붙음

6. 순서 없는 목록에서 [Tab]을 눌러 항목을 들여쓰면 여러 단계를 가진 목록을 만들 수도 있음

7. 텍스트 강조
   - 굵게 : **굵게하고픈 텍스트** 또는 __굵게 하고픈 텍스트__
   - 기울임체 : *기울이게 하고픈 텍스트*, _기울이게 하고픈 텍스트_
   - 굵은 기울임체 : ***이나 ___으로 앞 뒤 눌러쌈
   - 취소선 : 취소선을 나타낼 텍스트의 앞 뒤를 ~~로 감쌈

8. 인용 : 삽입 시 인용문의 첫 번째 줄 앞에 '>' 추가, 인용문 안 또 다른 인용문 삽입 '>>' 추가

9. 소스코드 : 텍스트 사이에 소스 코드 삽입
   - ` 기호 사용
   - 여러 줄 소스 삽입 시 ```를 붙이고 뒤에 javascript나 python 등 프로그래밍 언어를 함께 지정 시 해당 언어에 맞는 소스 형태로 표시됨
책 'Do it! 지옥에서 온 문서 관리자 깃&깃허브 입문' p.216

  - 해당 기호는 쉼표가 아닌 키보드 [1] 키 왼쪽의 [ ~ ` ] 키
  - 그레이브(grave) 키, 백팃(backtick) 키, 백쿼트(backquote) 키
  - 소스 코드로 표시하면 고정폭(fixed-width) 글꼴로 나타남

10. 링크 : 링크 주소는 다음과 같은 형태로 삽입 가능
  ① <링크 주소>
      - 링크 주소가 그대로 화면에 나타나고 누르면 해당 주소로 이동
  ② [링크 텍스트](링크 주소)
      - 링크 텍스트만 타나나며 클릭 시 괄호에 입력한 주소로 이동
  ③ [링크 텍스트](링크 주소, "부가 설명")
      - 링크 텍스트 위로 커서를 올리면 부가 설명한 내용이 말풍선 형태로 나타나고 클릭 시 입력한 주소로 이동

11. 이미지
   ![이미지 연습](이미지 파일 경로)
   - 마크다운에서 이미지 삽입 시 ! 를 붙인 후 대체 텍스트와 이미지 파일 경로 지정
   - 이 때, 이미지 파일이 경로를 가지려면 웹에 올라와 있어야 하므로 웹 사이트를 운영하고 있다면 웹 사이트에 이미지 파일을 올린 뒤 그 경로를 가져와 사용
   - 대체 텍스트 : 이미지를 나타낼 수 엇ㅂ는 상황이나 화면 낭독기에서 이미지를 소리로 설명할 수 있도록 삽입하는 텍스트

 

 

깃허브에 이미지 올리고 README에 삽입하기

따로 웹 사이트를 운영하지 않는 경우
- 이미지 파일을 깃허브 저장소에 직접 올린 다음 그 경로를 README 파일에서 지정

1. 컴퓨터에 이미지를 모아 둘 images 디렉터리 만들기 > 디렉터리 안에 필요한 이미지 모아 두기

- 깃허브 저장소에 직접 이미지를 올릴 수도 있지만 커밋 관리 중인 다른 파일들과 섞이지 않도록 별도의 디렉터리를 만들어 관리하는 것이 좋음

- 계속해서 이미지를 추가해 사용할 예정이라면 지역 저장소 안에 넣어두는 것이 관리하기 쉬움

 

2. 이미지를 사용할 저장소에 접속한 후 [Upload files] 클릭

 

3. 파일 탐색기에서 만들어 둔 images 디렉터리를 클릭해 깃허브 저장소로 끌어 옴

 

4. [Commit changes] 클릭해 커밋 > 깃허브 저장소에 images 디렉터리가 생김

 

5. README.md 오른쪽의 연필 아이콘 클릭

 

6. ![대체 텍스트](경로)

ex) 깃허브의 images 디렉터리에 있는 cat.jpg 이미지 삽입

![고양이 이미지](./images/cat.jpg)

 

7. 수정한 내용 커밋 [Commit changes] > README 안에 올리기 한 이미지가 나타남

- 이미지 파일 이름에 한글이 들어갈 경우 나타나지 않을 수 있음 > 영어로 파일 이름 바꿔주기

728x90
728x90