GitHub 이슈 및 PR 작성

매뉴얼

이슈 작성 #

구글 및 라이믹스 사용자 커뮤니티에서 답을 찾을 수 있는지 먼저 확인해 주십시오.
관련된 이슈가 이미 있는지 검색하고, 같은 내용이라면 댓글로 덧붙여 주십시오. 오래된 이슈라도 메일로 알림이 전달되므로 묻힐 염려가 없습니다.
무관한 이슈에 댓글을 달지 말아 주십시오. 엉뚱한 사람에게 메일 알림이 전달됩니다.
2가지 이상 서로 다른 문제가 있는 경우, 각각 이슈를 등록해 주십시오.
보안 취약점은 공개적으로 언급하지 말고 devops@rhymix.org로 알려 주시면 감사하겠습니다.
버그 신고 전 자신의 서버가 Rhymix의 설치 환경을 충족하는지 확인해 주십시오.
- 자신의 서버 환경은 phpinfo를 사용하여 확인할 수 있습니다.
- 낮은 PHP 버전, 확장 미설치, 퍼미션 관련 오류는 호스팅 업체에 문의하셔야 합니다.
버그 신고에는 아래의 내용을 반드시 포함시켜 주십시오.
- 실행 환경
- 호스팅 환경에 대한 간단한 설명 (예: ○○24 리눅스 웹호스팅)
- Rhymix 버전 (예: 2.0.3)
- PHP 버전 (예: 7.2.32)
- 운영체제, 브라우저 종류 및 버전 (예: Windows 10 IE 11, iOS 14 Safari 등)
- 에러가 발생하는 경우 에러 메시지 전체
- 화면상에 에러가 표시되거나 디자인이 깨져 보이는 경우, 해당 스크린샷
- 브라우저의 개발자도구(F12)에 에러가 표시되는 경우, 콘솔 및 네트워크 탭의 스크린샷
- 증상을 확인해 볼 수 있는 웹사이트 주소
- 내부망이나 로컬 개발환경 등 외부인의 접속이 원천적으로 불가능한 경우가 아니라면 반드시 주소를 남겨 주시기 바랍니다.
- 공개적인 개발을 추구하는 오픈소스 소프트웨어의 특성상, 이슈 해결에 필요한 정보를 공개하지 않는 경우 처리가 지연되거나 제3자에게 비용을 지불하고 해결해야 하는 등 불이익이 발생할 수 있습니다.

풀 리퀘스트(PR) 작성 #

자신의 저장소에서 별도의 브랜치를 만들어 작업하신 후, develop 브랜치로 풀 리퀘스트를 넣어주시면 됩니다.
- 예: 썸네일 관련 버그를 수정하는 경우 자신의 저장소에서 fix/thumbnail 브랜치를 만들어 작업하십시오. 작성 후에 수정할 것이 있으면 이 브랜치에서 계속 작업하고 커밋하시면 됩니다. PR 페이지에 자동으로 반영됩니다.
개발 진행 및 안정화에 따라 브랜치별 운영 정책이 변경될 수 있으니 유의하십시오.
코딩 규칙을 지키려고 노력해 주시기 바랍니다.
코딩 규칙에 맞지 않는 소스를 발견하더라도 PR의 주제와 관계없는 부분은 함부로 고치지 마세요! 코딩 규칙에 맞도록 소스를 수정하는 작업은 모두 별도의 PR로 처리하여야 합니다.
단, PR을 검토하는 개발자들은 괄호의 위치와 같은 사소한 문제를 지적하느라고 실제 기능에 관심을 주지 못하는 오류를 범하지 않도록 노력해야 합니다.
PR의 제목은 커밋 메시지에 적용되는 규칙을 참고하되, 가능하면 한글로 작성해 주십시오.
유닛 테스트를 통과하지 못하거나, 단지 유닛 테스트를 통과하기 위해 테스트 항목을 삭제할 경우 PR이 거부될 수 있습니다. 단, 테스트 자체에 문제가 있거나 테스트 내용을 변경해야 한다고 생각되는 경우 개발팀과 의논해 주십시오.

저작권 및 라이선스 #

풀 리퀘스트를 작성하실 경우 위의 두 가지에 동의하시는 것으로 간주합니다.