독서

[지옥에서 온 관리자 깃&깃허브 입문] 6장. 깃허브에서 개발자와 소통하기

찐공log 2022. 1. 22. 02:09

2022.01.21 - [독서/IT・컴퓨터] - [지옥에서 온 관리자 깃&깃허브 입문] 5장. 깃허브로 협업하기

 

[지옥에서 온 관리자 깃&깃허브 입문] 5장. 깃허브로 협업하기

2022.01.21 - [독서/IT・컴퓨터] - [지옥에서 온 관리자 깃&깃허브 입문] 4장. 깃허브로 백업하기 1. 여러 컴퓨터에서 원격 저장소 함께 사용하기 (1) 원격 저장소 복제하기 git clone 원격 저장소를 기존

zzingonglog.tistory.com

 

 

 

1.깃허브 프로필 관리하기

깃허브에 자신의 정보나 프로필 사진을 올릴 수 있습니다. 이 부분은 깃허브를 쓰다보면 자연스럽게 아는 부분이라 생략하도록 하겠습니다.😉

 

 

 

2. README 파일 작성하기

많은 깃허브 사용자는 방문자가 편하게 자기 저장소를 살펴볼 수 있도록 안내문을 만들어 첫 화면에 띄어둡니다. 이를 README 문서라고 합니다.

 

(1) README 파일 만들기

README 파일은 마크다운 문법을 사용하므로 확장자는 .md 입니다.

저장소에서 add a README 버튼을 통해 작성할 수 있습니다.

문서 작성시 줄을 바꾸려면 엔터를 두 번 눌러야 합니다.

수정이 완료됐으면 Commit new file을 누릅니다.

저장소 첫 화면에 작성한 README 파일의 내용이 나타납니다.

 

 

(2) 마크다운 문법 알아보기

README파일의 확장자가 .md인 것은 마크다운 형식으로 작성되기 때문인데요.

마크다운은 사용이 쉽고 html보다 간단하기 때문에 문서 작성이 편리합니다.

단 마크다운을 지원하는 프로그램이나, 사이트에서만 사용할 수 있습니다.

마크다운은 아래 url에서 자세하게 알아볼 수 있어요.

https://guides.github.com/features/mastering-markdown/

 

 

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

 

1️⃣ 사용자 컴퓨터에 이미지 디렉터리를 만들어 둡니다. 이미지를 계속 추가하면서 사용할 예정이라면 지역 저장소 안에 넣어두는 것이 관리하기 쉽습니다.

 

2️⃣이미지를 사용할 저장소에 접속한 후 Upload files를 누릅니다.

 

3️⃣파일 탐색기에서 아까 만들어준 images 디렉터리를 누르고 깃허브 저장소로 끌어옵니다.

 

4️⃣이미지 파일을 올렸으면 Commit changes를 누릅니다.

 

5️⃣이제 이 이미지파일을 README 문서에 넣어봅시다.

다음과 같이 입력합니다.

![대체 텍스트 입력](./images/test.jpeg)
 

 

6️⃣수정이 완료됐으면 README 파일을 커밋합니다.

 

7️⃣이미지가 나타나게 됩니다.

이미지 파일 이름이 한글일 경우 나타나지 않을 수 있으니 영문으로 작성해주세요.

 

 

 

3. 오픈 소스 프로젝트에 기여하기

(1) 컨트리뷰션의 종류

깃허브에서 기여 활동을 나타내는 말인 컨트리뷰션에는 소스의 버그를 수정하는 것뿐만 아니라 그 오픈 소스에 도움이 될만한 거의 모든 활동이 포함됩니다.

오픈 소스 프로젝트에 가장 많이 참여하는 분야는 소스 코드 수정입니다. 개발 능력을 갖춘 사용자라면 오픈 소스의 버그를 찾아서 알려주거나 찾은 버그를 수정하는 등 오픈 소스 자체를 수정하는 활동입니다.

 

 

(2) 오픈 소스 저장소 복제하기

이 책의 저자의 저장소를 한번 복사해볼게요.

https://github.com/peacein/doit

오픈소스 저장소 복제하는 방법은 저장소의 오른쪽 상단의 Fork버튼을 누르면 됩니다.

그러면 내 계정에 해당 저장소가 복제되어 있을 것입니다.

해당 저장소는 지역 저장소로 클론하여 작업을 할 수 있습니다.

그리고 내가 수정한 부분을 원본 저장소의 개발자한테 합쳐달라고 요청하는 것이 풀 리퀘스트입니다.

 

 

(3) 포크한 저장소를 지역 저장소로 클론하기

포크한 소스는 깃허브의 원격 저장소에 있기 때문에 사용자 컴퓨터로 저장소를 복제한 뒤 지역 저장소에서 수정하고 푸시합니다.

git clone 복사한 주소 doit
 

복제가 완료되어서 doit 디렉토리가 생성되었습니다.

여기서 demo.txt파일을 열고 간단한 내용을 추가하고 저장합니다. 그리고 커밋을 합니다.

그리고 git push 명령으로 수정한 파일을 원격 저장소로 올리면 커밋을 확인할 수 있습니다.

 

 

(4) 오픈 소스 프로젝트로 풀 리퀘스트 보내기

포크해 온 원격 저장소의 새로운 커밋을 원본 저장소에 합치는 방법을 알아보겠습니다.

먼저 원본 저장소의 개발자에게 내가 수정한 것을 반영해달라고 요청해야합니다.

이 요청을 풀 리퀘스트라고 부릅니다.

 
포크한 자신의 저장소에서 파일 목록 위에 있는 New pull request를 누릅니다.

원본 저장소(peacein/doit)의 master브랜치와 복제된 저장소의 master브랜치 사이에 어떤 차이가 있는지 보여줍니다.

여기서 Create pull request를 누르게 되면 요청이 됩니다.

 

 

 

 

4. 깃허브에 개인 블로그 만들기

GitHub Pages 기능을 사용하면 별도의 웹 호스팅 서비스를 사용하지 않고도 무료로 자기만의 홈페이지를 열 수 있습니다. 여기서는 이 기능을 사용해 개인 블로그를 만들어 보겠습니다.

 

 

(1) GitHub Pages 알아보기

저장소에 홈페이지 파일을 올린 뒤 저장소의 주소를 그대로 홈페이지 주소로 사용할 수 있습니다.

혹은 미리 만들어진 테마를 사용할 수도 있습니다.

즉, 깃허브 저장소를 웹 서버처럼 활용할 수 있습니다.

GitHub Pages는 포트폴리오나 기술 문서 같이 정적인 페이지를 제공할 때 사용하기가 좋습니다.

GitHub Pages를 사용하는 방법은 크게 2가지가 있는데요.

홈페이지 부트스트랩 등의 html 파일을 올리거나, 깃허브에서 지원하는 지킬 테마를 가져다 쓰는 방법이 있습니다.

검색하여 오픈 소스 저장소를 찾을 수 있습니다.

 

 

(2) 홈페이지 파일이 있을 때 GitHub Pages 사용하기

먼저 계정 옆의 + 버튼을 누르고 New repository 를 클릭합니다.

위 그림 처럼 Repository name 필드에 계정명.github.io 라고 입력합니다.

그리고 아래 Add a README file 에 체크를 반드시 하고 Create repository를 누릅니다.

 

그 다음 Upload files를 누릅니다.

 

그리고 드래그앤드랍으로 images 폴더나 css 폴더, html 파일을 넣습니다.

 

저장소에 여러 파일을 업로드 했다면 이제 홈페이지를 확인해봅니다.

깃허브 저장소 화면에서 Settings를 누르면 위와 같은 화면이 출력됩니다.

 

화면을 아래로 내려서 GitHub Pages 항목을 찾습니다. Check it out here!을 누르면 사이트가 제대로 만들었다는 메시지가 나타날 것입니다.

 

실제로 홈페이지 주소를 입력해서 제대로 열리는지 확인해볼 수 있습니다.

 

 

(3) 홈페이지 파일이 없을 때 GitHub Pages 사용하기

지킬 테마는 GitHub Pages로 블로그나 사이트를 열 때 쓸 수 있는 디자인과 스타일 모음을 말합니다.

아래와 같은 사이트를 참고하여 원하는 디자인을 가져올 수 있습니다.

http://jekyllthemes.org/

 

테마 소스를 그대로 포크해서 사용하는 방법을 알아보겠습니다.

우선 jekyll-now로 검색을 하여 barryclark이라는 사람의 jekyll-now를 포크해봅시다.

 

그러면 깃허브 계정 안에 jekyll-now 저장소가 복제됩니다. 저장소를 GitHub Pages로 사용하려면 저장소 이름을 '계정명.github.io'로 바꿔야 합니다.

 

setting에서 Repository 이름을 zzingongLog.github.io로 입력하고 rename합니다.

 

지킬 테마를 사용하려면 가장 먼저 환경을 설정해야합니다. 저장소에 있는 파일 목록 중 '_config.yml' 파일을 누릅니다.

파일을 수정하여 같이 홈페이지에 표출할 정보들을 작성하고 커밋합니다.

 

블로그가 생성되었습니다.😄 변경내용이 적용되려면 약간의 시간이 필요하니 몇 분 정도 기다려주세요.

 

 

(4) 블로그에 포스트 작성하기

지킬 테마에서 블로그 포스트는 _posts 디렉터리에 저장됩니다. 깃허브 저장소에서 _posts 디렉터리를 열어봅시다.

포스트 파일이름은 20xx-x-x-파일이름.md 형식입니다. 포스트는 마크다운 문법을 사용해 작성해야 합니다.

수정버튼을 눌러봅시다.

 

여기서 ---부터 ---까지는 모든 포스트에 꼭 들어가야합니다.

layout:post는 수정하면 안되고 title 부분은 포스트 제목입니다.

새포스트를 작성하기 위해 --- 부터 --- 부분을 복사합니다.

 

새 파일을 만들어서 작성합니다. 파일명은 20xx-x-x-파일이름.md 형식에 맞추어야 합니다.

입력이 끝났으면 커밋합니다.

 

웹브라우저에서 확인해봅시다.

실제 나타나는데에는 시간이 약간 걸릴 수 있으니 조금만 기다려주세요.

포스트가 추가된 것이 잘 보입니다!

 

 

(5) 포스트에 이미지 삽입하기

jekyll-now 테마에서는 images 디렉토리를 사용하고 있으므로 이곳에 이미지를 넣습니다.

그리고 포스트를 수정하여 아래의 형식에 맞추어 이미지를 지정합니다.

![대체텍스트](/images/파일이름)
 

커밋을 하기 전에 Preview 를 눌러 이미지가 제대로 보이는지 확인합니다.

 

 

브라우저에서도 제대로 나타나는 것이 보입니다.