제육's 휘발성 코딩
반응형

프로젝트와 폴더에 대한 문서

README.md

GitHub 프로젝트 페이지를 보면 README.md 파일을 봤을 것이다. 이 파일은 HTML 처럼 문서화를 꾸밀 수 있는 마크다운 형식을 사용한다. 폴더 안에 README.md 파일을 생성하면 메인 폴더가 아닌 서브 폴더 내에서도 구성할 수 있다.

 

마크다운 사용 문서 : https://www.markdownguide.org/cheat-sheet/

깃헙 제공 가이드 문서 : https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

풀 리퀘스트와 이슈

Pull Request

변경사항을 merge 하기 전에 코드 리뷰를 거치기 위한 과정으로 팀원들의 동의를 거친 뒤 대상 브랜치에 적용시키는 방식을 사용하기 위한 기능이다. 흔히 PR이라고 부른다.

PR 사용법
  • 새로운 브랜치 생성 후 변경사항 커밋하여 푸쉬

image

  • GitHub 레포지토리 페이지에서 Compare & pull request 버튼 클릭
    • 또는 ~ branches 에서 New pull request 클릭

image

  • 메시지 작성 후 Create pull reqeust 클릭
PR 검토 후 처리하기

image

  • GitHub 레포지토리에서 Pull requests 탭 클릭
  • 대상 PR 클릭하여 내용 검토
    • 의견이 있을 시 코멘트 달기
    • 반려해야 할 시 Close pull request
    • 승인할 시 Merge pull request

이슈

image

  • 다음과 같이 이슈를 생성하고 labels, Milestones 등을 등록하고 이슈를 관리할 수 있다. (label 과 Milestones 는 커스터마이징 하여 사용할 수 있다.)

오픈소스에 참여하기

  • 프로젝트별 참여 가이드 예시 : https://github.com/facebook/react
  • 프로젝트를 fork 하여 가져온다 - 코드 기여 (수정 후 PR 요청) - 오픈소스 주인이 확인 후 풀리퀘 반영

GitHub 블로그 만들기

image

GitHub Pages 가이드 링크 : https://pages.github.com/

레포지토리 생성

  • 레포지토리명 : (내 아이디).github.io 로 지을 것
  • 로컬로 클론

최상위 디렉토리에 index.html 생성

  • vs code 팁 : ! 입력하고 엔터 누르면 기본 HTML 템플릿 생성
  • 내용 작성 뒤 push

사이트 확인

  • https://(내 아이디).github.io 에서 확인 (시간이 어느 정도 걸린다.)

본 포스팅은 '인프런 - 제대로 파는 Git & GitHub - by 얄코' 강의를 보고 정리한 내용입니다.

반응형
profile

제육's 휘발성 코딩

@sasca37

포스팅이 좋았다면 "좋아요❤️" 또는 "구독👍🏻" 해주세요! 맞구독은 언제나 환영입니다^^