How to contribute code

로컬로 옮기기

• Github 에서 자신의 저장소로 Fork를 한다.

다음과 같은 URL로 저장소가 생긴다 https://github.com/YOUR_ID/screpl

• git으로 자신의 로컬PC로 저장소를 옮긴다.

$ git clone https://github.com/YOUR_ID/screpl

• 리모트 저장소 upstream을 추가한다.

$ git add remote upstream https://github.com/mighty1231/screpl

개발하기

• 자신이 개발하고자 하는 branch를 찾는다. 일반적으로 develop branch에서 개발하는 것을 권장한다.

특정 기능들은 feature- 접두가 붙은 branch에서 개발중이며 해당 기능 관련 개발은 그에 맞게 branch를 설정해주기를 부탁한다.

2020.04.22 현재 locedit 및 logger 가 개발중에 있다. git branch 를 활용하여 branch 목록을 살펴볼 수 있다.

• upstream branch로 부터 작업 branch를 생성한다. 자신의 작업 branch 이름은 개발하려는 기능에 맞게 지으면 좋다.

$ git checkout -b my_branch --track upstream/develop

• 나만의 코딩을 한다. 🔨

(my_branch)$ git status
(my_branch)$ git add file1 file2
(my_branch)$ git commit -m "some commit message"

Pull Request 진행하기

• 오랜시간이 흐른 뒤 upstream 에 변화가 있을 수 있으니 pull 한다.

(my_branch)$ git pull --rebase upstream/develop

• 당신의 github 저장소에 push 한다

(my_branch)$ git push origin my_branch_name

• 자신의 github에 들어가, origin/my_branch_name을 upstream/develop에 merge하는 pull request를 진행한다