Skip to content

Latest commit

 

History

History
108 lines (68 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

108 lines (68 loc) · 3.43 KB
Raw

Contributing to Hamonize

환영합니다!

먼저 시간내서 프로젝트에 참여해 주셔서 감사합니다.

이 문서는 프로젝트 참여 방법에 대한 가이드 라인 입니다.

언제든지 저희에게 여러분의 아이디어를 PR요청으로 문서변경을 제안해주세요.

개선 제안

프로젝트에 제안하려는 경우 최대한 상세하게 이슈에 등록해 주세요.

이슈를 작성하기전에 이미 요청이 있는지 이슈 목록을 확인해주세요.

버그 보고

버그 발견시 이슈에 BUG 라벨로 정보를 제공해 주세요.

최대한 상세하게 작성해 주시고 스크린샷을 첨부해주시면 더 좋습니다.

참여 가능 목록

  • 개발

    • 모든 기능

  • 기획 / 퍼블리싱

    • UI/UX 구성
    • 페이지 작업
    • 기타

  • 문서

    • README,CONTRIBUTING 등 문서 작업
    • 기타

*참여부분을 저희에게 알려주세요. 더욱 자세하게 설명드립니다.

이슈 또는 Slack채널을 이용해 주세요.


컨트리뷰션 가이드라인

1. Fork

  • Upstream Repository를 자신의 GitHub 계정으로 Fork 합니다.

2. Clone

  • Fork한 Repository를 자신의 Local working directory로 Clone 합니다.
$ mkdir -p $working_dir
$ cd $working_dir
$ git clone https://github.com/hamonikr/hamonikr-system.git

3. Create a branch

  • 개발용 branch를 생성하여 해당 branch에서 작업 및 테스팅을 수행합니다.
$ cd hamonize
$ git checkout -b myfeature

4. Commit

  • 수정 사항을 commit합니다.
$ git commit -a -m '[commit message]'

5. Push

  • 수정 사항을 자신의 GitHub Repository에 Push 합니다.
git push origin myfeature

6. 빌드 테스트

  • travis-ci 를 통해 수정한 소스코드가 정상적으로 빌드 되는 것을 확인해 주세요.
1) travis-ci.com 에 접속, github 계정으로 로그인

2) 포크한 저장소 활성화

3) 환경변수 GITHUB_TOKEN 등록

4) release 브랜치를 작업한 브랜치의 상태로 업데이트

5) travis-ci에서 이뤄진 빌드가 'passed' 인 것을 확인

7. Pull Request 생성하기

  • 자신의 Github Repository에서 수정 및 테스팅이 완료되면, New pull request 버튼을 클릭해 Pull Request를 생성합니다.

  • Pull Request를 생성할 때, comment로 해당 이슈가 논의된 위치와 수정된 사항에 대한 설명을 포함해 주세요.

8. CLA

  • 생성한 Pull Request에 Contributor License Agreement 사인 방법을 안내하는 댓글이 생성됩니다.

  • 안내에 따라 CLA 사인을 완료하면, Upstream Repository의 관리자가 요청된 Pull Request를 검토할 것입니다.

9. Feedback

  • 프로젝트 관리자가 Pull Request를 검토한 후, 수정을 요청하거나, 거절하거나, 수락할 것입니다.