deps/npm/man/man7/npm-disputes.7

   1 .TH "NPM\-DISPUTES" "7" "March 2015" "" ""
   2 .SH "NAME"
   3 \fBnpm-disputes\fR \- Handling Module Name Disputes
   4 .SH SYNOPSIS
   5 .RS 0
   6 .IP 1. 3
   7 Get the author email with \fBnpm owner ls <pkgname>\fR
   8 .IP 2. 3
   9 Email the author, CC support@npmjs\.com
  10 .IP 3. 3
  11 After a few weeks, if there's no resolution, we'll sort it out\.
  12
  13 .RE
  14 .P
  15 Don't squat on package names\.  Publish code or move out of the way\.
  16 .SH DESCRIPTION
  17 .P
  18 There sometimes arise cases where a user publishes a module, and then
  19 later, some other user wants to use that name\.  Here are some common
  20 ways that happens (each of these is based on actual events\.)
  21 .RS 0
  22 .IP 1. 3
  23 Joe writes a JavaScript module \fBfoo\fR, which is not node\-specific\.
  24 Joe doesn't use node at all\.  Bob   wants to use \fBfoo\fR 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\.
  27 .IP 2. 3
  28 Bob writes an npm module \fBfoo\fR, and publishes it\.  Perhaps much
  29 later, Joe finds a bug in \fBfoo\fR, and fixes it\.  He sends a pull
  30 request to Bob, but Bob doesn't have the time to deal with it,
  31 because he has a new job and a new baby and is focused on his new
  32 erlang project, and kind of not involved with node any more\.  Joe
  33 would like to publish a new \fBfoo\fR, but can't, because the name is
  34 taken\.
  35 .IP 3. 3
  36 Bob writes a 10\-line flow\-control library, and calls it \fBfoo\fR, and
  37 publishes it to the npm registry\.  Being a simple little thing, it
  38 never really has to be updated\.  Joe works for Foo Inc, the makers
  39 of the critically acclaimed and widely\-marketed \fBfoo\fR JavaScript
  40 toolkit framework\.  They publish it to npm as \fBfoojs\fR, but people are
  41 routinely confused when \fBnpm install foo\fR is some different thing\.
  42 .IP 4. 3
  43 Bob writes a parser for the widely\-known \fBfoo\fR file format, because
  44 he needs it for work\.  Then, he gets a new job, and never updates the
  45 prototype\.  Later on, Joe writes a much more complete \fBfoo\fR parser,
  46 but can't publish, because Bob's \fBfoo\fR is in the way\.
  47
  48 .RE
  49 .P
  50 The validity of Joe's claim in each situation can be debated\.  However,
  51 Joe's appropriate course of action in each case is the same\.
  52 .RS 0
  53 .IP 1. 3
  54 \fBnpm owner ls foo\fR\|\.  This will tell Joe the email address of the
  55 owner (Bob)\.
  56 .IP 2. 3
  57 Joe emails Bob, explaining the situation \fBas respectfully as
  58 possible\fR, and what he would like to do with the module name\.  He
  59 adds the npm support staff support@npmjs\.com to the CC list of
  60 the email\.  Mention in the email that Bob can run \fBnpm owner add
  61 joe foo\fR to add Joe as an owner of the \fBfoo\fR package\.
  62 .IP 3. 3
  63 After a reasonable amount of time, if Bob has not responded, or if
  64 Bob and Joe can't come to any sort of resolution, email support
  65 support@npmjs\.com and we'll sort it out\.  ("Reasonable" is
  66 usually at least 4 weeks, but extra time is allowed around common
  67 holidays\.)
  68
  69 .RE
  70 .SH REASONING
  71 .P
  72 In almost every case so far, the parties involved have been able to reach
  73 an amicable resolution without any major intervention\.  Most people
  74 really do want to be reasonable, and are probably not even aware that
  75 they're in your way\.
  76 .P
  77 Module ecosystems are most vibrant and powerful when they are as
  78 self\-directed as possible\.  If an admin one day deletes something you
  79 had worked on, then that is going to make most people quite upset,
  80 regardless of the justification\.  When humans solve their problems by
  81 talking to other humans with respect, everyone has the chance to end up
  82 feeling good about the interaction\.
  83 .SH EXCEPTIONS
  84 .P
  85 Some things are not allowed, and will be removed without discussion if
  86 they are brought to the attention of the npm registry admins, including
  87 but not limited to:
  88 .RS 0
  89 .IP 1. 3
  90 Malware (that is, a package designed to exploit or harm the machine on
  91 which it is installed)\.
  92 .IP 2. 3
  93 Violations of copyright or licenses (for example, cloning an
  94 MIT\-licensed program, and then removing or changing the copyright and
  95 license statement)\.
  96 .IP 3. 3
  97 Illegal content\.
  98 .IP 4. 3
  99 "Squatting" on a package name that you \fIplan\fR to use, but aren't
 100 actually using\.  Sorry, I don't care how great the name is, or how
 101 perfect a fit it is for the thing that someday might happen\.  If
 102 someone wants to use it today, and you're just taking up space with
 103 an empty tarball, you're going to be evicted\.
 104 .IP 5. 3
 105 Putting empty packages in the registry\.  Packages must have SOME
 106 functionality\.  It can be silly, but it can't be \fInothing\fR\|\.  (See
 107 also: squatting\.)
 108 .IP 6. 3
 109 Doing weird things with the registry, like using it as your own
 110 personal application database or otherwise putting non\-packagey
 111 things into it\.
 112
 113 .RE
 114 .P
 115 If you see bad behavior like this, please report it right away\.
 116 .SH SEE ALSO
 117 .RS 0
 118 .IP \(bu 2
 119 npm help 7 registry
 120 .IP \(bu 2
 121 npm help owner
 122
 123 .RE
 124