품질 가이드라인
환영합니다
XE Store에 오신 것을 환영합니다! 귀하의 시간과 노력에 감사 드리며, 고품질 익스텐션과 테마로 최고의 CMS 플랫폼을 구축하겠습니다.
이 문서의 목적은 창작자가 검토 관정을 이해하고 속도를 높이도록 돕는 데 있습니다. 이 가이드라인은 마켓플레이스 제품의 품질과 XE CMS 생태계의 수준을 높이기 위한 것입니다. 이 문서는 검토 과정에서 항상 건설적인 피드백을 제공하고 창작자가 제출한 플러그인을 수정하고 개선하는 데 도움을 줄 것입니다.
시간을 갖고 문서를 주의 깊게 읽어주세요. 규칙을 따르면 귀하의 제품을 더 빨리 게시할 수 있습니다. 플러그인을 제출하기 전에 플러그인을 신중하게 테스트해야 합니다.
문서의 일부 항목에는 권장사항이 있지만 고급 플러그인을 개발하려면 해당 항목을 따르는 것이 바랍직합니다. 이 문서에서 가능한 모든 규칙을 설명하려고 했습니다. 새로운 제출은 종종 새로운 도전 및 질문을 제기하여 새로운 규칙을 초래할 수 있으며 우리는 도입된 변경사항을 반영하기 위해 이 문서를 정기적으로 업데이트 할 것입니다.
편집 권한
창작자는 플러그인 설명 및 스크린샷의 사소한 편집을 수행할 수 있습니다. 여기에서 문법 및 문장 부호 오류 수정, 텍스트 내용의 스타일링 개선, 스크린샷 자르기 등을 포함합니다.
일반적인 거절 이유
플러그인 제출 이후에 대다수의 플러그인이 직면하게 되는 여러가지 공통적인 거부 사유가 있습니다.
- 설치 중 데이터베이스 이주 오류
- 런타임 오류 - 플러그인 코드가 백엔드의 오류를 유발하거나 프론트엔드 웹사이트를 중단시킵니다.
- 플러그인 이름, 설명 또는 문서가 정확하지 않고 잘못 작성되었거나 형식이 잘못되었거나 제품 기능과 관련이 없습니다.
- 플러그인 아이콘 또는 스크린샷이 규칙을 준수하지 않습니다.
1. 개발자 가이드
- 개발자는 프로그래밍 및 개발할 때 개발자 가이드를 따라야 합니다. 개발자 가이드라인에 설명된 규칙을 위반하면 제출이 거부될 수 있습니다.
2. 창작자 이름
- 창작자 이름은 다른 창작자 이름을 모방하거나 흉내 내서는 안됩니다. 예를 들어, 몇 글자를 변경하거나 분명히 유사하다고 판단되는 이름을 사용하는 것이 있습니다.
- 창작자 이름은 다른 CMS 또는 블로그와 같은 플랫폼의 이름을 포함해서는 안됩니다.
3. 신규 플러그인 공통적인 요구사항
- 플러그인은 특정 문제를 해결해야 합니다. 내장된 CMS 기능을 사용하여 플러그인 기능을 이미 쉽게 수행할 수 있는 경우에는 플랫폼 사용자 경험을 위해서 거부될 수 있습니다.
- 플러그인은 기존 플러그인과 너무 유사하면 안됩니다. 동일한 문제를 같은 방식으로 해결하는 다른 플러그인이 있다면 우리는 새로운 플러그인을 거부할 수 있습니다.
4. 개발자 도구
- 플러그인 설명은 다른 플러그인 소스코드의 변경을 조장해서는 안됩니다. 설명은 자신의 플러그인에서 플러그인에서 다른 창작자의 플러그인이 제공하는 기능을 사용하는 방법을 설명해야 합니다. 최종 사용자는 플러그인을 사용하기 위해 다른 플러그인의 코드를 업데이트 할 필요가 없습니다.
5. 카테고리
플러그인에 적합한 카테고리를 선택하여야 합니다. 카테고리를 통해 사용자가 쉽게 플러그인을 찾을 수 있습니다. 카테고리는 최대 2개를 선택할 수 있습니다. 카테고리를 선택하는 데 어려움이 있는 경우에는 유사한 게시된 플러그인을 찾아 참고하는 것이 좋습니다.
6. 플러그인 설명
플러그인 설명에는 이름, 요약 설명, 상세 설명 및 부가 정보가 있습니다.
- 이름, 요약 설명, 상세 설명, 부가 정보는 문법적 오류 없이 작성되어야 합니다.
- 제목, 목록 및 기타 텍스트 요소는 목적에 따라 적절하게 사용해야 합니다. 예를 들어 제목은 문서의 섹셕을 구분할 때만 사용해야 하며 텍스트의 일부를 강조하는 데 사용해서는 안됩니다. 너무 짧은 단락은 지양합니다. 링크 목록과 순서 목록에 적합한 목록 스타일을 사용합니다.
- 보안상의 이류로 HTML 태그는 제품 설명 및 문서 필드에 허용되지 않습니다.
- 간단한 설명은 간략하지만 플러그인 기능을 정확하게 표현해야 합니다.
- 상세 설명은 플러그인이 하는 일을 기술하고, 플러그인에 포함된 모든 기능을 언급하며, 최종 사용자를 위해 플러그인을 사용하고 구성하는 방법을 설명해야 합니다. 상세 설명에서 플러그인의 프로그래밍 측면에 대해 자세히 다루어서는 안됩니다.
- 개발자를 위해 제품을 사용하는 것에 대한 기술과 설명은 상세 설명 하단에서 언급해야 합니다. 플러그인이 제공하는 구성 요소의 설명, 구성 요소의 속성 및 구성 요소가 CMS 페이지에 삽입하는 변수 등을 설명할 수 있습니다.
- 플러그인에 대한 의존성은 고객이 사이트에 플러그인을 등록하기 전에 확인할 수 있도록 상세 설명에 내용이 설명되어야 합니다.
7. 코드 및 기능
- 플러그인 설치 중에 오류가 없어야 합니다.
- 플러그인은 관리자페이지와 프론트엔드에 버그를 표시하면 안됩니다.
- 플러그인에는 대상 시스템에 대한 보안 위협이 될 수 있는 코드가 포함되어서는 안됩니다.
- 플러그인 코드는 품질이 있어야 하며 현대적인 코딩 표준을 준수해야 합니다. 여기에는 지정된 코딩 스타일, MVC 패턴의 올바른 사용, xpressengine.io 가이드 문서에 설명 된 개념과 지침을 포함합니다. 다만 이에 국한하지 않습니다.
- 플러그인은 XE와 번들 플러그인과 같이 보급 된 호환 소프트웨어의 최신 릴리즈 버전으로 작동해야 합니다. 다른 플러그인 또는 스크립트가 주요/중요 업데이트를 수신할 수 있으므로 고객이 이전 버전을 사용할 것으로 기대하는 것은 무리입니다.
- 익스텐션은 XE 코어에 포함된 기존 기능을 가능한 많이 사용해야 합니다.
- 테마는 게시물로 등록된 모든 위젯을 포함해야 합니다.
- 테마는 XE 코어에 포함된 모든 위젯을 해당 영역에 올바르게 표시되어야 하며, 기존 위젯을 등록 해제하면 안됩니다. 대신 플러그인을 통해 새 위젯을 등록해야합니다.
- 익스텐션은 다른 플러그인과의 충돌 문제를 피하기 위해 모든 함수와 클래스, 훅, 공용/전역 변수 및 데이터베이스 항목 앞에 고유한 식별자가 있어야 합니다.
- 더 이상 사용되지 않는 함수는 코드 기반에서 허용하지 않습니다,.
8. 아이콘
플러그인 아이콘은 XE Store 뿐만 아니라, 관리자페이지에서도 표시되는 정사각형 이미지입니다.
- 아이콘은 JPG, PNG 파일로 등록할 수 있습니다.
- 원본 이미지 크기는 400x400px 이상이어야 합니다.
- 아이콘 이미지는 플러그인 목적과 일치하거나 명확한 은유를 사용해야 합니다.
- 여러 기능 및 플러그인을 통합하는 플러그인에는 브랜드 아이콘을 사용하는 것이 좋습니다.
9. 배너 이미지
배너 이미지는 플러그인 페이지 상단에 표시되는 이미지입니다. 배너는 제품을 차별화하고 눈에 더 잘 띄도록 도와줍니다. 품질이 우수한 배너 그래픽이 포함 된 플러그인은 고객이 사용할 가능성이 높습니다.
- 배너 이미지는 200MB 이하의 JPG, PNG 파일로 등록할 수 있습니다.
- 배너 이미지 크기는 1024x576px 이상이어야 합니다.
- 배너 이미지의 권장 화면 비율은 16:9 입니다.
- 배너 이미지는 미적이어야 합니다.
- 이미지에 브라우저 창과 같은 프레임이나 관련 요소(스크롤바, 글 주소 패널 등)가 없어야 합니다.
- 배너 이미지에 윈도우 그림자가 없어야 합니다.
- 배너 이미지는 크기 요구사항에 맞게 이미지 편집기로 크기 조정(압착)을 하지 않아야 합니다.
10. 스크린샷
스크린샷은 플러그인의 상세페이지에 표시되며 플러그인 대시보드, 예제 등을 설명하는 데 효과적으로 사용할 수 있습니다.
복잡한 플러그인 일 수록 스크린샷을 사용하는 것이 좋습니다. 품질이 높은 스크린샷을 제공하면 고객이 제품을 사용할 확률이 높아집니다. 반면 낮은 품질의 스크린샷을 제공하면 창작자가 개발에 투자 한 시간과 노력이 절감될 수 있습니다.
- 스크린샷은 제품과 관련된 페이지의 특정 영역을 보여주어야 하며, 플러그인 기능과 관련이 없는 빈 공간을 표시하면 안됩니다.
- 스크린샷은 미적이어야 합니다. 신중하게 이미지를 잘라내어 스크린샷에 포함한 설명과 스크린샷 테두리 사이에 여백을 두어야합니다.
- 스크린샷은 1024x576px 이상이어야 합니다.
- 스크린샷의 너비가 1200px보다 넓어서는 안됩니다.
- 스크린샷의 권장 화면 비율은 16:9 입니다.
- 스크린샷에 윈도우 그림자가 없어야 합니다.
- 스크린샷 이미지는 크기 요구 사항에 맞게 이미지 편집기로 크기 조정(압착)을 하지 않아야 합니다.
- 스크린샷은 100% 브라우저 줌을 사용해야 합니다. 글꼴을 축소하거나 확대해서는 안됩니다.
- 플러그인 스크린샷은 최대 5개를 등록할 수 있습니다.
11. 유저 인터페이스
- 새로운 UI를 만들기보다 기존의 폼 요소, UI 요소와 패턴을 사용하는 것을 권장합니다.
- 사용자 정의된 UI와 컨트롤은 일반적이고 범용적인 UI 디자인 스타일을 따라야 합니다.