README.md
프로젝트와 관련된 설명을 마크다운형식으로 표현한 문서
README.md파일은 프로젝트를 사용하는 사람들을 위한 일종의 소개글이다.
git에서 README.md파일을 작성할 때는 Mark Down문법을 사용한다.
Mark Down문법이란 일반 텍스트 문서의 양식을 편집하는 문법이다. 일반적으로 README파일, 온라인 문서, 혹은 일반 텍스트 편집기로 문서 양식을 편집할 때 사용된다.
Mark Down문법의 자세한 사용 방법은 해당 사이트에서 참고할 수 있다.
사용 방법
GitHub repository에서Add a README버튼 클릭
Mark Down문법으로 글 작성
- 작성된 글 확인
README파일 커밋
- 생성결과 확인
작성된 README파일은 VS Code와 같은 에디터에서 아래 명령어로 확인할 수 있다.
git pullPull Request
변경사항을
merge하기 전 팀원들의 리뷰를 거친 뒤 대상 브랜치에 적용
Pull Request는 작업자가 수정한 코드가 있을 때 branch를 가져가 검토 후 병합을 요청하는 것이다.
Pull Request는 코드의 충돌을 최소화할 수 있어 push 권한이 없는 오픈 소스 프로젝트에 기여할 때 주로 사용된다.
사용 방법
-
새로운 브랜치 생성 후 변경사항 커밋, 푸시
-
GitHub repository페이지의Compare & pull request버튼 클릭, 또는~ branches의New pull request클릭 -
메시지 작성 후
Create pull request클릭
검토 후 처리
-
GitHub repository페이지의Pull requests탭 클릭 -
대상
Pull Request클릭하여 내용 검토 -
필요시 코멘트 입력, 반려시
Close pull request, 승인시Merge pull request
Issue
프로젝트의 버그나 문제 제보, 추가할 기능 등의 이슈 소통
Issue는 작업의 버그 수정, 새로운 추가될 기능, 개선해야하는 기능...등등 모든 것이 해당된다.
모든 활동 내역에 대해 Issue를 등록한 뒤 등록한 Issue를 바탕으로 작업을 진행한다.
그리고 Issue를 만들면 Issue를 open하고, 작업이 끝나 Issue를 정리하면 Issue를 close한다.
사용 방법
-
GitHub repository페이지에서Issues탭 클릭 -
필요시
label또는milestone생성 (milestone: 이슈의 주제 묶음) -
이슈 작성 (필요시
label,milestone,asignee지정) -
이슈 확인 후 처리 (코멘트 달기, 관련 개발 착수, 해결 뒤
Close issue)
Fork
변경하고 싶은 부분을 나의
GitHub repository로 복제
fork는 다른 사람의 Github repository에서 내가 수정하고 싶은 부분 혹은 기능을 추가하고 싶을 때 해당 respository를 나의 Github repository로 복제하는 기능이다.
fork를 사용한 저장소는 원본(다른 사람의 github repository)과 연결되어 있다.
이 때 original repository에 변화가 발생하면 그대로 fork된 repository로 반영할 수 있다.
사용 방법
fork의 사용방법은 간단하다.
- 수정할 프로젝트를 내
repository로fork
fork된 프로젝트를clone
git clone repository주소- 코드 수정 후
pull request
Pages
GitHub에서 제공하는 계정별 무료 웹 호스팅
GitHub에서는 계정별로 무료로 사용할 수 있는 정적 웹 페이지를 제공한다.
이를 통해 개발자의 기술 블로그, 포트폴리오 페이지...등의 호스팅 공간을 만들 수 있다.
사용 방법
-
repository생성 (repository명은(아이디).github.io형식으로 작성하여 로컬로clone) -
최상위 디렉토리에
index.html작성하여push -
https://(아이디).github.io에서 사이트 확인
참고 자료
