Ticket #60: faq.html

File faq.html, 9.0 KB (added by Ipstenu, 11 years ago)


1<h2>Developer FAQ</h2>
3<h3 id="submissions">Questions about Submissions and Approval</h3>
5<h4 id="approvals">How long does it take to get a plugin approved?</h4>
7<p>There's no official average, as no two plugins are the same. If your plugin is small and all the code is correct, it shoud be approved within seven days. If your plugin has any code issues, it will take as long as it takes for you to correct the issues. Either way, you <em>will</em> get an email from with the status, so please add that to your email whitelist.</p>
9<h4 id="">If my plugin has a problem, how long do I have to fix it?</h4>
11<p>We allow for seven days from the time we contact you regarding the issue to when we expect you to be finished with corrections. It's one of the only ways we have to keep the queue small. If you need to take more than seven days, we'll reject your request and you can resubmit after you're done.</p>
13<h4 id="">Are there specific things you're looking for that I should avoid?</h4>
15<p>We look for some pretty obvious things, all of which are listed <a href="">in our guidelines</a>, and most can be summed up as 'Don't be a spammer,' but to touch on the ones people do the most:</p>
18        <li>A readme<br />This is what displays your plugin information on the repository page. It should explain how to use the plugin, even if you think it's obvious.</li>
19        <li>Test the plugin with WP_DEBUG on<br />We do. You shoudl before you submit. If the plugin doesn't work, we push back.</li>
20        <li>Including jquery scripts<br />WordPress comes with a great number of <a href="">default scripts</a> which we ask you not include in your plugin. Use ours.</li>
21        <li>Calling external files<br />All plugins should be as self contained as possible. Obviously, if your plugin relies on a service on your own servers (like Twitter), then calling JS remotely is fine. However if you're attempting to offload images and JS to a CDN without providing a service, we do not permit this.</li>
22        <li>'Powered By' links<br />All links on the forward facing aspect of a website must be "Opt In." This means your plugin may not default to link back to your site, or any other, on the part of the website that visitors see.</li>
23        <li>No phoning home<br />This is bigger than just not tracking users, but also not including files that send any data back to your servers (like iframes) unless that is a requirement for how your plugin works. Even then, we may ask about it.<li>
26<h4>Can I change my plugin's name?</h4>
28<p>Yes and no. You can change the display name, but the 'slug' - that part of the plugin URL that is yours - cannot be changed. So if you submit "My cool tool" as the name, your URL will be <code></code> and that will also be the folder name on everyone's site.</p>
30<h4>Are there names you don't permit?</h4>
32<p>We don't allow 'WordPress' in plugin names as it's redundant and somewhat obvious that you're a WordPress plugin. We also generally disallow using 'plugin' for the same reasons. Only English letters and Arabic numbers are permitted in the slug, so you cannot have, for example, Chinese or Arabic letters in the URL, for compatibility issues. We don't permit version numbers in plugins either.</p>
34<h4>I already have a plugin, but I want to re-do it! I just submit again right?</h4>
36<p>We'd rather you actually just re-write the existing plugin. Make it a major version. We can't rename plugins, so your new one won't get any of the old users.</p>
38<h3>Questions About The Repository</h2>
41<h4 id="directory">In what directory should I put my files?</h4>
43<p>Put your files directly in the <code>trunk/</code> directory of your repository. Whenever you release a new version, <a href="../svn/#task-3">tag that release</a> by copying the current trunk revision to a new subdirectory of the <code>tags/</code> directory.</p>
45<p>Make sure you update <a href="../readme.txt"><code>trunk/readme.txt</code></a> to reflect the new stable tag.</p>
47<p>Screenshot image files should ideally be put in the <code>assets/</code> directory (which you'll likely need to create) in the root of your SVN checkout. This will be on the same level as <code>tags/</code> and <code>trunk/</code>, for example. Alternatively, screenshots can be put in the directory of the tagged stable release (<code>trunk/</code> or the stable tag directory) (the old way). The <code>assets/</code> directory is preferred since the screenshots won't be packaged in the plugin's release zip files, saving unnecessary bloat for each download. Learn more from the feature's <a href="">announcement post</a>.</p>
49<h4 id="subdirectory">Can&rsquo;t I put my files in a subdirectory of <code>trunk/</code>?</h4>
51<p>You can, but it&rsquo;s silly. The <code>.zip</code> file the Plugin Directory creates will automatically wrap all your files inside a directory, so there is no need to put your files into a subdirectory.</p>
53<p>If you have complicated plugin with lots of files, you can of course organize them into subdirectories, but the <a href="../readme.txt">readme file</a> and the root plugin file should go straight into <code>trunk/</code>.</p>
55<h3 id="tag-names">How should I name my tags (a.k.a. releases)?</h3>
57<p>Your subversion tags should look like version numbers. Specifically, they should only contain <strong>numbers and periods</strong>. <code>2.8.4</code> is a good lookin&rsquo; tag, <code>my neato releaso</code> is a bad lookin&rsquo; tag. Inflexible? Yup. Easy to handle and sanitize? You bet!</p>
59<p>Note that we&rsquo;re talking about subversion tags here, not readme.txt tags. Those can obviously be any words you like.</p>
61<h4 id="plugin-version">Can I specify what version of my plugin the Plugin Directory should use?</h4>
63<p>Yes, by specifying the <code>Stable Tag</code> field in your trunk directory&rsquo;s <a href="../readme.txt">readme file</a>.</p>
65<h4 id="data">Where does the Plugin Directory get its data?</h4>
67<p>From the information you specify in the plugin file and in the <a href="../readme.txt">readme file</a>, and from the subversion repository itself.</p>
70        <dt>Authors</dt>
71        <dd><code>Author</code> field from the plugin header and <code>Contributors</code> field from the readme file.</dd>
73        <dt>Version</dt>
74        <dd><code>Version</code> field from the plugin header.</dd>
76        <dt>Tags (as in categories)</dt>
77        <dd><code>Tags</code> field from the readme file.</dd>
79        <dt>Plugin Name</dt>
80        <dd>The <code>Plugin Name</code> from the readme file falling back on the <code>Plugin Name</code> specified in the plugin header.</dd>
82        <dt>Author and Plugin Homepages</dt>
83        <dd>The <code>Author URI</code> and <code>Plugin URI</code> fields of the plugin header.</dd>
85        <dt>Last updated time</dt>
86        <dd>Time of last check in to the appropriate directory (<code>trunk/</code> or the stable tag directory) <strong>after a version number change</strong>.</dd>
88        <dt>Creation time</dt>
89        <dd>Time of first check in.</dd>
92<h4>I made some changes to my SVN repository. How long will it take for the Plugin Directory to reflect those changes?</h4>
94<p>The Plugin Directory updates every few minutes, however it may take longer for your changes to appear, depending on how deep the queue is.</p>
96<h4>Can I include SVN externals in my plugin?</h4>
98<p>Nope, sorry.  You can add <a href="">svn externals</a> to your repository, but they won&rsquo;t get added to the downloadable zip file.</p>
100<h4>How do I make one of those cool banners for my plugin page?</h4>
102<p>Start by creating an <code>assets/</code> directory in the root of your SVN checkout. This will be on the same level as <code>tags/</code> and <code>trunk/</code>, for example.</p>
104<p>Inside that <code>assets/</code> directory, you can make a file named "banner-772x250.png" or "banner-772x250.jpg". The image must be exactly 772 pixels wide and 250 pixels tall. No GIFs.</p>
106<p>To support high-DPI (aka "retina") displays, you can additionally make a file named "banner-1544x500.png" or "banner-1544x500.jpg". The image must be exactly 1544 pixels wide and 500 pixels tall. No GIFs. This image, if present, will only be served when the website detects that the viewing browser is on a high-DPI display. Read this feature's <a href="">announcement post</a> for more details and special notes about creating this image.</p>
108<p>After you check in your new banner(s), it will appear the next time the plugin refreshes itself in the directory. This may take a few minutes.</p>
110<p>For development and testing, you can add a URL parameter to your plugin's URL of "?banner_url=A_LINK_TO_YOUR_IMAGE" to preview what the page will look like with your own image. This will only work with your own plugins, you can not use this parameter on anybody else's plugins.</p>