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

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