org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/doc/misc/npm-disputes.md

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