deps/npm/html/doc/misc/npm-disputes.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-disputes</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../misc/npm-disputes.html">npm-disputes</a></h1> <p>Handling Module Name Disputes</p>
  10
  11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
  12
  13 <ol><li>Get the author email with <code>npm owner ls &lt;pkgname&gt;</code></li><li>Email the author, CC <a href="mailto:i@izs.me">i@izs.me</a>.</li><li>After a few weeks, if there&#39;s no resolution, we&#39;ll sort it out.</li></ol>
  14
  15 <p>Don&#39;t squat on package names.  Publish code or move out of the way.</p>
  16
  17 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  18
  19 <p>There sometimes arise cases where a user publishes a module, and then
  20 later, some other user wants to use that name.  Here are some common
  21 ways that happens (each of these is based on actual events.)</p>
  22
  23 <ol><li>Joe writes a JavaScript module <code>foo</code>, which is not node-specific.
  24 Joe doesn&#39;t use node at all.  Bob   wants to use <code>foo</code> in node, so he
  25 wraps it in an npm module.  Some time later, Joe starts using node,
  26 and wants to take over management of his program.</li><li>Bob writes an npm module <code>foo</code>, and publishes it.  Perhaps much
  27 later, Joe finds a bug in <code>foo</code>, and fixes it.  He sends a pull
  28 request to Bob, but Bob doesn&#39;t have the time to deal with it,
  29 because he has a new job and a new baby and is focused on his new
  30 erlang project, and kind of not involved with node any more.  Joe
  31 would like to publish a new <code>foo</code>, but can&#39;t, because the name is
  32 taken.</li><li>Bob writes a 10-line flow-control library, and calls it <code>foo</code>, and
  33 publishes it to the npm registry.  Being a simple little thing, it
  34 never really has to be updated.  Joe works for Foo Inc, the makers
  35 of the critically acclaimed and widely-marketed <code>foo</code> JavaScript
  36 toolkit framework.  They publish it to npm as <code>foojs</code>, but people are
  37 routinely confused when <code>npm install foo</code> is some different thing.</li><li>Bob writes a parser for the widely-known <code>foo</code> file format, because
  38 he needs it for work.  Then, he gets a new job, and never updates the
  39 prototype.  Later on, Joe writes a much more complete <code>foo</code> parser,
  40 but can&#39;t publish, because Bob&#39;s <code>foo</code> is in the way.</li></ol>
  41
  42 <p>The validity of Joe&#39;s claim in each situation can be debated.  However,
  43 Joe&#39;s appropriate course of action in each case is the same.</p>
  44
  45 <ol><li><code>npm owner ls foo</code>.  This will tell Joe the email address of the
  46 owner (Bob).</li><li>Joe emails Bob, explaining the situation <strong>as respectfully as possible</strong>,
  47 and what he would like to do with the module name.  He adds
  48 isaacs <a href="mailto:i@izs.me">i@izs.me</a> to the CC list of the email.  Mention in the email
  49 that Bob can run <code>npm owner add joe foo</code> to add Joe as an owner of
  50 the <code>foo</code> package.</li><li>After a reasonable amount of time, if Bob has not responded, or if
  51 Bob and Joe can&#39;t come to any sort of resolution, email isaacs
  52 <a href="mailto:i@izs.me">i@izs.me</a> and we&#39;ll sort it out.  (&quot;Reasonable&quot; is usually about 4
  53 weeks, but extra time is allowed around common holidays.)</li></ol>
  54
  55 <h2 id="REASONING">REASONING</h2>
  56
  57 <p>In almost every case so far, the parties involved have been able to reach
  58 an amicable resolution without any major intervention.  Most people
  59 really do want to be reasonable, and are probably not even aware that
  60 they&#39;re in your way.</p>
  61
  62 <p>Module ecosystems are most vibrant and powerful when they are as
  63 self-directed as possible.  If an admin one day deletes something you
  64 had worked on, then that is going to make most people quite upset,
  65 regardless of the justification.  When humans solve their problems by
  66 talking to other humans with respect, everyone has the chance to end up
  67 feeling good about the interaction.</p>
  68
  69 <h2 id="EXCEPTIONS">EXCEPTIONS</h2>
  70
  71 <p>Some things are not allowed, and will be removed without discussion if
  72 they are brought to the attention of the npm registry admins, including
  73 but not limited to:</p>
  74
  75 <ol><li>Malware (that is, a package designed to exploit or harm the machine on
  76 which it is installed).</li><li>Violations of copyright or licenses (for example, cloning an
  77 MIT-licensed program, and then removing or changing the copyright and
  78 license statement).</li><li>Illegal content.</li><li>&quot;Squatting&quot; on a package name that you <em>plan</em> to use, but aren&#39;t
  79 actually using.  Sorry, I don&#39;t care how great the name is, or how
  80 perfect a fit it is for the thing that someday might happen.  If
  81 someone wants to use it today, and you&#39;re just taking up space with
  82 an empty tarball, you&#39;re going to be evicted.</li><li>Putting empty packages in the registry.  Packages must have SOME
  83 functionality.  It can be silly, but it can&#39;t be <em>nothing</em>.  (See
  84 also: squatting.)</li><li>Doing weird things with the registry, like using it as your own
  85 personal application database or otherwise putting non-packagey
  86 things into it.</li></ol>
  87
  88 <p>If you see bad behavior like this, please report it right away.</p>
  89
  90 <h2 id="SEE-ALSO">SEE ALSO</h2>
  91
  92 <ul><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-owner.html">npm-owner(1)</a></li></ul>
  93 </div>
  94 <p id="footer">npm-disputes &mdash; npm@1.3.15</p>
  95 <script>
  96 ;(function () {
  97 var wrapper = document.getElementById("wrapper")
  98 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  99   .filter(function (el) {
 100     return el.parentNode === wrapper
 101         && el.tagName.match(/H[1-6]/)
 102         && el.id
 103   })
 104 var l = 2
 105   , toc = document.createElement("ul")
 106 toc.innerHTML = els.map(function (el) {
 107   var i = el.tagName.charAt(1)
 108     , out = ""
 109   while (i > l) {
 110     out += "<ul>"
 111     l ++
 112   }
 113   while (i < l) {
 114     out += "</ul>"
 115     l --
 116   }
 117   out += "<li><a href='#" + el.id + "'>" +
 118     ( el.innerText || el.text || el.innerHTML)
 119     + "</a>"
 120   return out
 121 }).join("\n")
 122 toc.id = "toc"
 123 document.body.appendChild(toc)
 124 })()
 125 </script>