상위 문서: 라이믹스/매뉴얼
개요
라이믹스 코어의 버그·개선 제안은 공식 GitHub 저장소의 이슈로, 코드 변경 제안은 풀 리퀘스트(PR)로 제출한다. 이 문서는 공식 기여 안내를 정리한 것이다.
이슈 작성 전
- 공식 문서와 커뮤니티에서 같은 증상과 해결 방법을 찾는다.
- 기존 이슈를 검색한다. 같은 문제라면 관련 정보를 해당 이슈에 덧붙인다.
- 설치 환경을 충족하는지 확인하고 코어 문제와 서버 설정·서드파티 자료의 문제를 구분한다.
- 서로 다른 문제는 별도 이슈로 작성한다. 관계없는 이슈에 댓글을 달면 해당 참여자에게 불필요한 알림이 전달된다.
보안 취약점은 공개 이슈나 댓글에 올리지 않는다. 공식 안내에 따라 [email protected]로 비공개 제보한다. 자세한 내용은 라이믹스/보안을 참고한다.
버그 제보에 포함할 정보
| 항목 | 내용 |
|---|---|
| 실행 환경 | 호스팅 종류, OS, 라이믹스와 PHP 버전, 관련 확장 |
| 재현 방법 | 어떤 화면에서 무엇을 했는지, 기대 결과와 실제 결과 |
| 오류 | 정확한 오류 메시지와 관련 로그 |
| 화면 문제 | 문제 화면 및 필요하면 개발자 도구의 콘솔·네트워크 기록 |
| 확인 가능한 주소 | 외부에서 증상을 확인할 수 있는 URL. 로컬·내부망이면 그 제약을 설명 |
| 관련 자료 | 사용하는 모듈·스킨과 버전, 서드파티를 제외했을 때도 발생하는지 |
로그나 스크린샷을 올리기 전 비밀번호·세션 쿠키·API 키·개인정보를 가린다. 서버 환경을 확인하기 위해 사용한 phpinfo() 화면 전체를 공개할 필요는 없다.
작성 예
제목: 특정 조건에서 첨부파일 업로드 실패
환경: 라이믹스 버전 / PHP 버전 / 호스팅 종류 / 브라우저
재현: 1. 로그인 2. 글쓰기 3. 지정 형식 파일 첨부
기대 결과: 파일 첨부 완료
실제 결과: 오류 메시지와 발생 시점
추가 확인: 기본 스킨·애드온 비활성화 환경에서의 재현 여부
PR 작성
- 저장소를 포크하고 변경 목적이 드러나는 별도 작업 브랜치를 만든다.
- 한 PR은 한 문제에 집중한다. 관련 없는 들여쓰기·스타일 수정은 별도 PR로 나눈다.
- 코딩 규칙과 지원 환경을 지키고 관련 테스트를 실행한다.
- 변경 전 문제, 변경 후 동작, 재현·검증 방법을 설명하여 PR을 작성한다.
- 검토 후 수정할 내용은 같은 작업 브랜치에 커밋한다. 해당 PR에 반영된다.
공식 매뉴얼은 기본적으로 master를 대상으로 안내하지만, 개발 진행과 안정화에 따라 브랜치 정책이 달라질 수 있다고 명시한다. 제출 시 현재 저장소의 기여 안내와 대상 버전의 정책을 확인한다. PR 제목은 가능한 한 한글로 명확히 작성한다.
테스트를 통과하기 위해 정상적인 테스트를 삭제하지 않는다. 테스트 자체의 수정이 필요하다면 이유를 설명하고 개발팀과 논의한다.
저작권과 라이선스
기여 코드의 저작권은 작성자에게 남으며, 공식 기여 안내는 GPL v2 또는 이후 버전 적용을 명시한다. 다른 사람의 코드를 포함한다면 해당 라이선스와 호환되어야 한다. 제출 전 공식 안내의 저작권·라이선스 조건을 확인한다. 이 매뉴얼 문서의 CC BY-SA와 소프트웨어 코드의 GPL은 구분한다.
같이 보기
출처
이 문서는 라이믹스 공식 매뉴얼을 바탕으로 설명과 예제를 정리하였다. 공식 매뉴얼은 CC BY-SA 4.0으로 배포된다. 원문의 기여 이력은 rhymix-docs 저장소에서 확인할 수 있다.