내가 WordPress.org 에 넣어 첫 번째 플러그인은 아홉 일 동안 아무것도 배송. 나는 코드를 커밋 했다,출시 태그를 지정,내 새로운 설명과 목록 업데이트를 보고,사람들에게 그것이 밖으로 했다. 다운로드 버튼이 빈 태그 폴더를 제공 했기 때문에 다운로드는 평평 하 게 유지: 내 readme.txt 라고 Stable tag: 1.0.1 그리고 제가 실제로 만든 태그는 다음과 같습니다 1.0. 아무것도 경고하지 않았습니다. 디렉토리는 내가 말한대로 정확하게했습니다.
그 라인은 워드 프레스 플러그인에서 가장 높은 지분 필드입니다's readme.txt그리고,큰 소리로보다는 조용히 실패하는 몇몇의 한개 이다. 이 가이드는 손상이 일어나기 위하여 경향이 있는 순서대로,디렉토리가 저 파일의 각 부분을,무엇을 하는지 커버한다. The 워드 프레스 Readme 생성기 적용되는 필드에 이러한 규칙이 첨부된 파일을 빌드합니다.
TL;DR:
Stable tag디렉토리가 실제로 제공하는 버전의 이름을 지정합니다. 에서 읽습니다trunk/readme.txt그리고 아래 폴더를 가리킵니다/tags/그것이 존재해야 하고 릴리스를 포함해야 합니다. 존재하지 않는 버전의 이름을 지정하면 사용자는 아무것도 얻지 못합니다; 여전히 오래된 버전의 이름을 지정하면 무엇을 커밋했든 오래된 코드를 얻습니다.Tested up to목록에 있는 호환성 경고를 제어합니다Tags처음 5개만 색인화하고 짧은 설명은 150자로 잘라냅니다.
Stable 태그는 실제로 무엇을 제어합니까?
디렉토리의 플러그인은 Subversion에 있습니다 trunk/ 현재 개발을 위해 그리고 tags/<version>/ 릴리스의 경우. 누군가가 다운로드를 클릭하면 디렉토리가 보내지 않습니다 trunk. 읽습니다 trunk/readme.txt, 발견하다 Stable tag를, 그리고 봉사한다 tags/<that value>/.
세 가지 결과가 뒤따르고 세 가지 모두 실제 릴리스를 물어뜯습니다:
- 이것을 결정하는 readme는 트렁크에 있는 것입니다. 태그 폴더 안의 readme를 편집하면 어떤 배송이 이루어졌는지에 대해 아무것도 변경되지 않습니다.
- 태그가 존재해야 합니다. A
Stable tag생성되지 않은 폴더의 이름을 지정하면 다운로드가 비어 있거나 실패한다는 의미입니다. - 트렁크는 사용자가 받는 것이 아니다. 일주일 내내 트렁크에 커밋할 수 있습니다; 안정적인 태그가 움직일 때까지 릴리스된 코드는 이전 태그가 보유한 모든 것입니다.
X-1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 10 플러그인 핸드북 규칙을 명백하게 진술하고,다른 플러그인에서 readme 를 복사하고 필드를 편집하는 것보다 한 번 제대로 읽을 가치가 있습니다. 알 가치가있는 한 가지 예외: Stable tag: trunk does mean "serve trunk", 이는 합법적이며 소수의 플러그인 릴리스 방법입니다. 또한 트렁크에 대한 모든 커밋이 모든 사용자에게 즉시 적용된다는 의미이므로 거의 아무도 그렇게해서는 안됩니다.
readme 가 전혀 제어하지 않는 릴리스의 후반부가 있습니다. 버전 in Stable tag 일치해야 합니다 Version: 주 플러그인 PHP 파일의 헤더,그것이 설치 된 사이트가 업데이트가 존재 하는지 여부를 결정 하는 것에 비교 하기 때문에. 플러그인 헤더가 여전히 이전 번호를 말하고 디렉토리가 이미 존재 하는 버전 이라고 주장 하는 것을 설치 하는 업데이트를 제공 하는 태그를 발송 합니다.
각 헤더 라인이 목록에 수행하는 작업
헤더 블록은 9줄의 일반 블록입니다 Key: value 그리고 그들 모두는 눈에 보이는 것을 변화시킵니다.
| 라인 | 하는 일 | 무엇이 잘못되었는가 |
|---|---|---|
Stable tag |
제공되는 버전을 선택합니다 | 잘못된 가치는 아무것도 배송하지 않거나 오래된 코드를 배송합니다 |
Requires at least |
최소 워드프레스 버전 | 작동 할 너무 높은 블록 설치 |
Tested up to |
호환성 문 | 뒤쳐지는 것은 "untested"를 보여줍니다. 경고 |
Requires PHP |
최소 PHP 버전 | 너무 낮으면 호환되지 않는 사이트가 설치되고 실패할 수 있습니다 |
Tags |
디렉토리 키워드 | 처음 5개만 색인화됩니다 |
Contributors |
링크 WordPress.org 프로필 | 오타는 조용히 아무도 인정하지 않습니다 |
Donate link |
사이드바 기부 버튼 | 결석은 괜찮고, 망가진 것은 그렇지 않습니다 |
License / License URI |
라이센스 | 목록에 등록되려면 GPL과 호환되어야 합니다 |
Tested up to 은 조용히 다운로드 비용이 하나입니다. 뒤에 몇 가지 핵심 릴리스보다 떨어지면 목록은 방문자에게 플러그인이 워드 프레스의 자신의 버전으로 테스트되지 않은 것을 알리는 통지를 표시하고,버려 보이는 플러그인은 작동 여부에 관계없이 덜 설치됩니다. 그 라인을 업데이트하는 것은 트렁크에 대한 readme 커밋이며 생태계에서 가장 저렴한 유지 보수 인 1 분이 걸립니다.
Tags 인덱스 다섯. 여섯 번째 태그는 오류가 아니며 경고를 생성하지 않습니다; 그것은 단순히 당신의 파일에 죽은 텍스트입니다. 다섯 사람이 실제로 입력 선택.
설명은 어떻게 분할되며, 왜 중요한가요?
한 readme에는 두 가지 설명이 있으며 서로 다른 작업을 수행합니다.
X-1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 10 짧은 설명 헤더 라인과 첫 번째 라인 사이의 단일 텍스트 블록입니다 == Section ==. 그것은 150 문자로 캡핑되어 있으며,디렉토리가 검색 결과와 플러그인 카드에서 그것을 자르는 과거,보통 중간 문장입니다. 이것은 대부분의 사람들이 클릭 여부를 결정하기 전에 읽는 줄이며,이는 150 문자를 파일에서 가장 가치있는 부동산으로 만듭니다.
X-1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 1000 X 10 긴 묘사 는 이다 == Description == 섹션과 그것은 당신의 리스팅 페이지의 본문이 됩니다. 그것은 Markdown 의 부분 집합을 취합니다: 표제,굵게, 기울임꼴,목록, 링크. 원시 HTML 은 제거됩니다. 테이블,구문 강조가 있는 울타리가 있는 코드 블록,그리고 더 이국적인 Markdown 은 렌더링하지 않기 때문에 Markdown 미리 보기에서 올바르게 보이는 readme 는 여전히 WordPress.org 에서 잘못 보일 수 있습니다.
다른 섹션은 각각 목록의 탭에 매핑됩니다:
== Description == the main body
== Installation == the Installation tab
== Frequently Asked Questions == the FAQ tab, one "= question =" per entry
== Screenshots == numbered captions, matched to files in /assets/
== Changelog == one "= version =" block per release, newest first
== Upgrade Notice == the short line shown inside wp-admin on update
Upgrade Notice 보통 얻는 것보다 더 많은 관심을받을 가치가있다. 그것은 대부분의 사용자가 업데이트를 클릭하기 전에 볼 수있는 유일한 텍스트입니다: 하나 또는 두 줄, 업데이트 프롬프트에서, 이 릴리스가 중요한 이유를 설명. 보안 수정, 깨는 변경, 새로운 PHP 요구 사항 빈 채로, 업데이트는 단지 숫자입니다.
배너와 아이콘은 어디에 살고 있나요?
에 없습니다 readme.txt. 이것은 거의 모든 사람이 처음으로 넘어지는데, 그 이유는 readme가 목록 콘텐츠의 다른 모든 부분이 나오는 곳이기 때문입니다.
이미지는 에 살고 있습니다 /assets/ 옆에 있는 SVN의 디렉토리입니다 trunk 그리고 tags, 파일 이름과 일치합니다:
| 파일 | 목적 | 크기 |
|---|---|---|
banner-772x250.png |
리스팅 헤더 | 772 x 250 |
banner-1544x500.png |
레티나 헤더 | 1544 x 500 |
icon-128x128.png |
검색 결과 아이콘 | 128 x 128 |
icon-256x256.png |
망막 아이콘 | 256 x 256 |
screenshot-1.png |
첫 스크린샷 | 어떤 |
스크린샷은 번호별로 readme에 다시 연결됩니다. screenshot-1.png 아래 첫 번째 줄로 설명됩니다 == Screenshots ==, screenshot-2.png 두 번째까지 등등. 일치하는 파일이 없는 캡션에는 아무것도 표시되지 않습니다; 캡션이 없는 파일에는 레이블이 지정되지 않은 이미지가 표시됩니다.
좋은 체인질로그는 어떤 모습일까요?
릴리스당 하나의 블록, 상단에 최신, 각 라인은 사용자 및#39;s 관점에서 변경된 내용을 나타냅니다:
= 3.2.5 =
* Fixed: admin menu order lost after a role change
* Improved: login customizer previews without saving
= 3.2.4 =
* Added: per-role dashboard widget visibility
"버그 수정 및 개선" 사용자에게 아무 것도 알려주지 않고 리뷰어에게 덜 알려줍니다. changelog 는 플러그인을 신뢰할지 여부를 결정하는 사람이 먼저 보이는 곳이기도 합니다: 특정 항목의 꾸준한 목록은 유지 관리로 읽히고 2 년의 간격은 코드가 여전히 작동하는지 여부에 관계없이 포기로 읽습니다.
긴 체인질로그는 다듬어도 괜찮습니다. 최근 릴리스를 계속 유지하세요 readme.txt 그리고 나머지는 a로 옮깁니다 changelog.txt; 디렉터리는 잘린 디렉터리를 읽고 기록은 저장소에 유지됩니다.
파일을 배송하기 전에 파일을 확인합니다
기계적 점검은 빠릅니다: 그렇습니다 Stable tag 존재하는 태그 폴더와 일치합니까 Version: 플러그인 헤더에는 다음과 같습니다 Tested up to current는 150자 미만의 짧은 설명으로, 태그가 5개 이하입니다.
WordPress.org에는 다음이 있습니다 공식 readme 검증자 이는 파일을 구문 분석하고 읽을 수 없는 내용을 보고하므로 릴리스당 한 번씩 실행할 가치가 있습니다. 그만큼 Readme 생성기 다른 방향을 취합니다: 필드에서 파일을 빌드하고, 적용되는 필드 옆에 이러한 각 제한을 명시하고, 파일이 생성할 목록을 미리 보고, 기존 파일을 읽습니다 readme.txt 다시 양식으로 돌아가서 오래된 플러그인's 파일을 다시 입력하지 않고도 최신 상태로 만들 수 있습니다.
만약 당신이 다른 사람을 보고's 플러그인 보다는 자신의 게시, the 워드 프레스 플러그인 감지기 페이지가 로드하는 내용을 나열합니다 테마 감지기 그 뒤에있는 주제를 읽습니다.
