본문 바로가기
카테고리 없음

지옥에서 온 문서관리자 5

by 수짱수짱 2022. 1. 19.

Day5

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

 

주요 내용만 작성 

  • 마크다운(.md) 문법
  • 오픈 소스 프로젝트 기여하는 방법

마크다운 문법

README파일의 확장자 .md

 

  • 제목
    • # 제목
    • ## 제목
    • # 6개까지 가능. #과 텍스트 사이 여백 필요
  • 텍스트 단락
    • Enter를 두 번 눌러 편집기에 빈 줄을 넣어야 한다.
  • 가로줄
    • ---
    • ----------
    • - - -
    • ***
    • *********
    • * * *
  • 순서 있는 목록
    • 1. 2. 3. 붙여서 나타낸다
    • 1. 3. 4. 2. 이렇게 순서대로 작성하지 않아도 순서 목록은 1,2,3,4,5 순서대로 나타난다.
  • 순서 없는 목록
    • +, -, *를 붙여서 나열
    • Tab을 눌러 들여 쓰면 여러 단계를 가진 목록을 생성
  • 텍스트 강조
    • 굵게 : **텍스트** or __텍스트__
    • 기울임체 : *텍스트* or _텍스트_
    • 굵은 기울임체 : ***텍스트*** or ___텍스트___
    • 취소선 : ~~텍스트~~
  • 인용
    • 첫 번째 줄 앞에 >를 추가
    • 인용문 안에 또 다른 인용문 삽입은 >>
  • 소스코드
    • ` (grave 키)사용
    • ` 소스코드 `
    • 여러줄의 소스를 삽입하는 것은 ``` 소스코드 ```
    • ```뒤에 javascript, python등 언어를 함께 지정하면 해당 언어에 맞는 소스 형태로 표현된다.
    • ```python 소스코드 ```
  • 링크
    • <링크주소>
    • [링크 텍스트](링크 주소)
    • [링크 텍스트](링크 주소, "부가 설명")
  • 이미지
    • 깃허브에 이미지 올리고 README에 삽입
      • ![이미지 설명](./깃허브디렉터리/cat.jpg)

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

 

  • 오픈 소스 저장소 복제하기 - fork
    • 수정하려는 오픈 소스 저장소를 자신의 저장소로 복제한다.
    • 다른 저장소에 있는 소스를 직접 수정해서는 안 되기 때문이다.
    • 저장소를 fork한 후에는 저장소의 소스나 README 파일을 수정할 수 있다. 
  • 포크한 저장소를 지역 저장소로 clone
    • git clone 포크한 저장소 주소 디렉터리 이름 
    • 해당 디렉터리로 이동해서 (cd) 파일 확인 
    • 해당 디렉터리에서 수정하고 커밋 후 푸쉬를 해도 포크한 저장소의 파일이 수정된 것 뿐이다.
    • 원래 소스가 있던 저장소에게 수정한 내용을 합쳐달라고 알려야 한다.
  • 오픈 소스 프로젝트로 pull request 보내기
    • fork해 온 원격 저장소의 새로운 커밋을 원본 저장소에 합치는 방법
    • 원본 저장소의 개발자에게 내가 수정한 내용을 반영해달라고 요청하는 것 -  pull reqest
    •  
      pull request 보내는 방법
    • 한 번 pull request 올린 뒤 계속해서 commit을 생성하게 되어도
    • 자동으로 원본 저장소에게 pull reqeust가 보내진다.