Difference between revisions of "Taking over a package"

From HaskellWiki
Jump to: navigation, search
m (mostly formatting)
(rewrite to make it clearer, and (I think) in-line with the hackage administrators agreed policy)
Line 1: Line 1:
There can be situations where a certain package on Hackage is in the need of an update (a typical example: a package cannot be compiled with some of the versions of the dependencies; or, on the contrary, dependencies list needs a version bump), but the maintainer of the package is unavailable. Luckily, there is a general policy that allows users to submit patched versions of the packages or even completely take over unmaintained packages.
+
There are situations where a certain package on Hackage is effectively unmaintained, or is simply in need of a minor update but the maintainer of the package is unavailable.
   
# Try to contact the maintainer. Give him/her reasonable time to respond.
+
= If you '''can''' contact the author/maintainer =
# State your intention to take over the package in a public forum (e.g., the haskell-cafe/libraries list). CC the maintainer.
 
# Wait a while.
 
# Send an email to the Hackage admin list, with a link to the public email thread.
 
# The admins or trustees will grant you maintenance rights or upload a patched version for you.
 
   
There is a faster way of gaining maintainership of a package, but it requires the current maintainer to be reachable:
 
  +
The author/maintainer may simply be too busy to do the updates, but may be happy to delegate or to pass on ownership entirely.
   
* The original maintainer can just give you access at http://hackage.haskell.org/package/<package>/maintainers/
 
  +
Explain what you want to do, for example if you want take over entirely, to share ongoing maintenance responsibility, or do a one-off update without any ongoing responsibility.
  +
  +
Ask them to give you permission to upload new versions of the package. What needs to happen technically is for your hackage username to be added to the maintainer group for the package in question. They can do this in one of two ways:
  +
 
* The current maintainer can do it directly on the package maintainer group page on hackage: <code>http://hackage.haskell.org/package/<package>/maintainers/</code>
  +
  +
: You will need to tell them your hackage username. They simply follow the "edit" link and add your username to the group.
   
 
''OR''
 
''OR''
   
* The maintainer emails the Hackage admin list, saying s/he wants you to take over the package.
+
* The current maintainer can email the Hackage administrators ([mailto:admin@hackage.haskell.org admin@hackage.haskell.org]), saying s/he wants you to take over the package, or at least wants you to be allowed to upload new versions.
  +
  +
: This is not the the Hackage administrators' preferred option for obvious reasons, but may be your best bet if the current maintainer is exceedingly busy.
  +
  +
  +
= If you '''cannot''' contact the author/maintainer =
  +
  +
This situation is more tricky because it involves overriding the normal rights of authors/maintainers.
  +
  +
The hackage administrators have a procedure for this situation which you can follow:
  +
  +
# Try to contact the maintainer. Give him/her reasonable time to respond.
  +
# State your intention to take over the package in a public forum (we recommend the haskell-cafe and/or libraries list). CC the maintainer.
  +
# Wait a while.
  +
# Send an email to the Hackage administrators ([mailto:admin@hackage.haskell.org admin@hackage.haskell.org]), with a link to the public email thread.
  +
# The admins will grant you maintenance rights or upload a patched version for you.

Revision as of 14:23, 13 February 2014

There are situations where a certain package on Hackage is effectively unmaintained, or is simply in need of a minor update but the maintainer of the package is unavailable.

If you can contact the author/maintainer

The author/maintainer may simply be too busy to do the updates, but may be happy to delegate or to pass on ownership entirely.

Explain what you want to do, for example if you want take over entirely, to share ongoing maintenance responsibility, or do a one-off update without any ongoing responsibility.

Ask them to give you permission to upload new versions of the package. What needs to happen technically is for your hackage username to be added to the maintainer group for the package in question. They can do this in one of two ways:

You will need to tell them your hackage username. They simply follow the "edit" link and add your username to the group.

OR

  • The current maintainer can email the Hackage administrators (admin@hackage.haskell.org), saying s/he wants you to take over the package, or at least wants you to be allowed to upload new versions.
This is not the the Hackage administrators' preferred option for obvious reasons, but may be your best bet if the current maintainer is exceedingly busy.


If you cannot contact the author/maintainer

This situation is more tricky because it involves overriding the normal rights of authors/maintainers.

The hackage administrators have a procedure for this situation which you can follow:

  1. Try to contact the maintainer. Give him/her reasonable time to respond.
  2. State your intention to take over the package in a public forum (we recommend the haskell-cafe and/or libraries list). CC the maintainer.
  3. Wait a while.
  4. Send an email to the Hackage administrators (admin@hackage.haskell.org), with a link to the public email thread.
  5. The admins will grant you maintenance rights or upload a patched version for you.