extlib/README

   1 DO NOT "FIX" CODE IN THIS DIRECTORY.
   2
   3 ONLY UPSTREAM VERSIONS OF SOFTWARE GO IN THIS DIRECTORY.
   4
   5 This directory is provided as a courtesy to our users who might be
   6 unable or unwilling to find and install libraries we depend on.
   7
   8 If we "fix" software in this directory, we hamstring users who do the
   9 right thing and keep a single version of upstream libraries in a
  10 system-wide library. We introduce subtle and maddening bugs where
  11 our code is "accidentally" using the "wrong" library version. We may
  12 unwittingly interfere with other software that depends on the
  13 canonical release versions of those same libraries!
  14
  15 Forking upstream software for trivial reasons makes us bad citizens in
  16 the Open Source community and adds unnecessary heartache for our
  17 users. Don't make us "that" project.
  18
  19 FAQ:
  20
  21 Q: What should we do when we find a bug in upstream software?
  22
  23 A: First and foremost, REPORT THE BUG, and if possible send in a patch.
  24
  25    Watch for a release of the upstream software and integrate with it
  26    when it's released.
  27
  28    In the meantime, work around the bug, if at all possible. Usually,
  29    it's quite possible, if slightly harder or less efficient.
  30
  31 Q: What if the bug can't be worked around?
  32
  33 A: If the upstream developers have accepted a bug patch, it's
  34    undesirable but acceptable to apply that patch to the library in
  35    the extlib dir. Ideally, use a release version for upstream or a
  36    version control system snapshot.
  37
  38    Note that this is a last resort.
  39
  40 Q: What if upstream is unresponsive or won't accept a patch?
  41
  42 A: Try again.
  43
  44 Q: I tried again, and upstream is still unresponsive and nobody's
  45    checked on my patch. Now what?
  46
  47 A: If the upstream project is moribund and there's a way to adopt it,
  48    propose having the StatusNet dev team adopt the project. Or, adopt
  49    it yourself.
  50
  51 Q: What if there's no upstream authority and it can't be adopted?
  52
  53 A: Then we fork it. Make a new name and a new version. Include it in
  54    lib/ instead of extlib/, and use the StatusNet_* prefix to change
  55    the namespace to avoid collisions.
  56
  57    This is a last resort; consult with the rest of the dev group
  58    before taking this radical step.