Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

27 lines (16 sloc) 2.462 kB
Naming Your Plugin
<p>Before you can list your plugin on this site, you'll need to choose a name for your plugin. The name is a unique identifier that distinguishes your plugin from all other plugins. This is different from the title of your plugin, which you can think of as the display name.</p>
<p><strong>Plugin names must begin with "jquery." and may only contain URL-safe characters.</strong></p>
<p>We encourage you to follow a few simple tips as well:</p>
<ul>
<li>Choose a name that is short, but also reasonably descriptive.</li>
<li>Match your plugin name to your file name, e.g., the jquery.foo plugin would live in a file named jquery.foo.js.</li>
<li>Check the site to see if the name you want is available, before getting your heart set on a name that's already taken.</li>
</ul>
<h2>First Come, First Serve</h2>
<p>Names are registered on a first come, first serve basis. Registering a name happens automatically the first time you <a href="/publish">publish a release</a> of your plugin. You cannot reserve a name prior to releasing your plugin. Once you've registered a name, you are the sole owner of that name. Nobody else will be able to publish a release using the same name. There is no limit on how many plugins/names a single person may register, but all plugins must be legitimate.</p>
<h2>Transferring Ownership</h2>
<p>While most plugins will only ever have one owner, there are times when the original owner may move on to other projects and wish to transfer ownership to someone else. There is currently no automated process for this, the original owner must contact a <a href="http://jquery.org/team">jQuery team member</a>, prove ownership and indicate who the new owner should be.</p>
<p>In the case of an abandoned plugin where the original owner is no longer active, the jQuery team can choose to change ownership at their discretion. These will indeed be a rare occurrence, likely requiring an event such as _why or Mark Pilgrim's infosuicide.</p>
<h2>Prefixes & Plugin Suites</h2>
<p>Certain prefixes will also be blacklisted for individual plugins. Large projects which include many plugins in a single repository, such as <a href="http://jqueryui.com">jQuery UI</a>, are registered as suites. Each suite is required to have a unique prefix and all of their plugin names must use that prefix. As such, no other plugin may use a name with a suite's prefix. Suites must be manually vetted by the jQuery team.</p>
Jump to Line
Something went wrong with that request. Please try again.