Pull Request 방법 논의

ratsgo commented 4 years ago

개요

본 리파지토리의 Pull Request 방법을 논의한다.

@DusanBaek

ratsgo commented 4 years ago

PR 절차

1. jekyll 환경 설치하기 : 본 블로그는 jekyll 기반이므로, 문서 수정 내용이 웹에서 어떻게 보이는지 로컬에서 확인하려면 jekyll 개발환경을 설치해야 함

MacOS : https://jekyllrb.com/docs/installation/macos
Windows : https://jekyllrb.com/docs/installation/windows

2. 본 리파지토리를 자신의 계정에 포크(fork)한 뒤 로컬에 클론 받은 후 브랜치 생성

자세한 내용은 다음 링크의 1~3번 과정을 수행
https://wayhome25.github.io/git/2017/07/08/git-first-pull-request-story

3. jekyll 의존성 패키지 설치 : 본 블로그의 테마(just-the-docs)가 의존하고 있는 패키지를 로컬에 설치

위에서 내려받은 git 디렉토리가 speechbook이라면, speechbook에서 다음 실행
```
bundle
```

4. 문서 수정 : 수정 대상 문서에 수정 내용 반영

본 블로그의 문서들은 docs 이하의 디렉토리에 markdown 형식으로 저장돼 있음
해당 마크다운 문서들을 수정

5. jekyll 컴파일한 뒤 로컬에서 확인 : 4의 수정 내용을 바로 푸시해도 되지만 로컬에서 어떻게 보이는지 확인한 후 푸시하는 것이 안전

speechbook 디렉토리에서 다음을 실행하면 아래 같은 메세지가 출력됨

> bundle exec jekyll serve
Configuration file: /Users/david/works/speechbook/_config.yml
        Source: /Users/david/works/speechbook
   Destination: /Users/david/works/speechbook/_site
Incremental build: disabled. Enable with --incremental
  Generating...
                done in 8.195 seconds.
Auto-regeneration: enabled for '/Users/david/works/speechbook'
Server address: http://127.0.0.1:4000/speechbook/
Server running... press ctrl-c to stop.

위의 http://127.0.0.1:4000/speechbook 주소를 웹 브라우저에 입력하면 문서 변경 사항을 로컬에서 확인 가능함
여기에서 의도대로 수정된 것이 확인되면 다음 절차 진행

6. add, commit..., Pull Request : 이후 절차는 일반적인 PR 절차와 동일

다음 문서의 4~7번 항목 수행
https://wayhome25.github.io/git/2017/07/08/git-first-pull-request-story

ratsgo commented 4 years ago

@DusanBaek 님 PR 절차를 위와 같이 정리해 봤는데요. @DusanBaek 님의 환경이 저와 다른 만큼 예상 못한 이슈가 있을 수도 있을 것 같은데요. 해당 내용은 이 이슈에 커멘트 주시면 같이 해결해 보았으면 좋겠습니다. 미리 감사드립니다.

ratsgo / speechbook

Pull Request 방법 논의 #7