Skip to content

Latest commit

 

History

History
122 lines (80 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

122 lines (80 loc) · 4.14 KB
Raw

기여하기

기여하기전에 아래 내용을 꼭 읽어주세요.

기여 방법

0. 저는 타학교 학생인데 이 레포를 사용해서 우리학교용 확장앱을 만들고싶어요.

  • 해당 레포를 활용하여 타학교용 확장앱을 개발하시는 경우, 웨일과 크롬 확장앱 소개란 및 Github에 원작자를 표시해주세요. 아래 내용 복사해서 작성해주시길 바랍니다.(2021/1/12 업데이트)
// 웨일용
Origin Repo: https://github.com/seohyun0120/Quick-Sook
Origin: 숙명여대 웨일 확장앱(퀵숙 Quick Sookmyung) - https://store.whale.naver.com/detail/lniagbhflokdpfoilcmcpdmaphllolai

// 크롬용
Origin Repo: https://github.com/seohyun0120/Quick-Sook
Origin: 숙명여대 크롬 확장앱(퀵숙 Quick Sookmyung) - https://chrome.google.com/webstore/detail/%ED%80%B5%EC%88%99-quick-sookmyung/ojiacghdlkbcfphkggebiiblbhheiopc

1. issue 확인

  • 먼저 작업을 진행하기 전에, 이슈목록을 확인해주세요.

  • 이슈 목록에 있다면, 댓글을 남겨주세요. 아래 형식에 맞춰 댓글을 남겨주시면, 빠른 시간내에 확인 후, 이슈 assign 해드리겠습니다.

    제가 해당 기능 개발, 수정해보겠습니다.
작업 예상 일정: ~ 2020.10.05(예상)

  • 이슈 목록에 없는 기능이라면, New issue 버튼을 클릭하여 이슈를 등록해주세요.

2. Pull Request

PR을 보내는 프로세스는 매우 간단합니다!

  1. 현재 레포 fork하기
  2. 새 브랜치 만들기
  3. 개발하기
  4. Upstream으로부터 rebase하기
  5. whale과 chrome에서 테스트하기
  6. Pull Request 보내기

Step 1: 현재-레포-fork하기

현재 레포의 fork 버튼을 눌러주세요.

Step 2: 새-브랜치-만들기

PR을 보내기 위해 fork한 레포지토리에서 브랜치를 만들어주세요. 브랜치 이름은 수정하려는 내용을 간단하게 표현해주세요. 따로 컨벤션은 없습니다. 자유롭게 써주세요.

$ git checkout -b add-new-quick-button

Step 3: 개발하기

개발이 완료되면 브랜치에 수정된 내용을 커밋해주세요.

$ git add -A
$ git commit

커밋 메세지는 커밋 내용을 요약해서 작성해주세요. 이 또한 자유롭게 써주시면 됩니다.

Step 4: Upstream으로부터-rebase하기

Pull Request를 보내기 전에 upstream 소스를 rebase 해야 합니다. 이를 통해 최신 코드를 가져와 conflict을 피할 수 있습니다.

먼저 remote 저장소를 확인합니다.

$ git remote -v
origin https://github.com/myusername/Quick-Sook.git (fetch)
origin https://github.com/myusername/Quick-Sook.git (push)
upstream # 이 라인은 나타나지 않을 수도 있음

만약 upstream이 설정되지 않았다면 upstream을 설정해주세요.

$ git remote add upstream https://github.com/seohyun0120/Quick-Sook.git

그 후, upstream 소스를 rebase 해주세요.

$ git fetch upstream
$ git rebase upstream/master

Step 5: whale과-chrome에서-테스트하기

수정한 부분이 잘 동작하는지 테스트하는 방법은 다음과 같습니다.

  • 크롬 브라우저

    chrome:// extensions

  • 웨일 브라우저

    whale://extensions

각 브라우저에서 다음 주소로 이동한 후, Load unpacked 버튼을 클릭해서 현재 개발중인 폴더를 올려서 테스트해보세요.

Step 6: Pull-Request-보내기

변경 내용을 clone한 레포지토리에 push합니다.

$ git push origin add-new-quick-button

이제 Pull Request를 보낼 준비가 완료되었습니다. Fork된 레포지토리로 이동하여 Pull Request를 보내주세요!

3. Merge PR!

여기서부터는 maintainer가 진행할 차례입니다. 코드 리뷰를 진행한 후, develop 브랜치에 merge를 하게 됩니다. develop 브랜치에 올라온 내용을 whale과 chrome에 심사를 맡긴 후, 심사가 통과되면 master 브랜치로 merge 하게 됩니다.