Difference between revisions of "Taking over a package"
(Added categories) |
(→If you cannot contact the author/maintainer: add Discourse in recommended forums) |
||
(6 intermediate revisions by 4 users not shown) | |||
Line 5: | Line 5: | ||
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 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, |
+ | Explain what you want to do, for example if you want to take over entirely, 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: |
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 |
+ | * The current maintainer can do it directly on the package maintainer group page on Hackage: <code>https://hackage.haskell.org/package/<package>/maintainers/</code><br/> You will need to tell them your hackage username. They simply follow the "edit" link and add your username to the group. |
− | |||
− | : 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 current maintainer can email the |
+ | * The current maintainer can email the hackage administrators ([mailto:hackage-admin@haskell.org hackage-admin@haskell.org]), saying s/he wants you to take over the package, or at least wants you to be allowed to upload new versions.<br/>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. |
− | |||
− | : 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 = |
= If you '''cannot''' contact the author/maintainer = |
||
Line 26: | Line 21: | ||
The hackage administrators have a procedure for this situation which you can follow: |
The hackage administrators have a procedure for this situation which you can follow: |
||
− | # Try to contact the maintainer. Give |
+ | # Try to contact the maintainer. Give them 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. |
+ | # State your intention to take over the package in a public forum (we recommend [https://discourse.haskell.org Discourse], the haskell-cafe and/or libraries list). CC the maintainer. |
# Wait a while. |
# Wait a while. |
||
− | # Send an email to the |
+ | # Send an email to the hackage administrators ([mailto:hackage-admin@haskell.org hackage-admin@haskell.org]), with a link to the public email thread. |
# The admins will grant you maintenance rights or upload a patched version for you. |
# The admins will grant you maintenance rights or upload a patched version for you. |
||
+ | == Timetable == |
||
+ | # From time of announcement of intention to takeover to actual takeover, there will be a 2-6 week period where the admins give the maintainer a chance to respond, with the exact time in any case up to the discretion of the admins. |
||
+ | # If someone has their package taken over because they did not respond, then, for the following year, should they request it, the admins will unconditionally return it to them. |
||
[[Category:FAQ]] |
[[Category:FAQ]] |
Latest revision as of 18:12, 23 August 2024
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 to take over entirely, 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:
https://hackage.haskell.org/package/<package>/maintainers/
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 (hackage-admin@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 them reasonable time to respond.
- State your intention to take over the package in a public forum (we recommend Discourse, the haskell-cafe and/or libraries list). CC the maintainer.
- Wait a while.
- Send an email to the hackage administrators (hackage-admin@haskell.org), with a link to the public email thread.
- The admins will grant you maintenance rights or upload a patched version for you.
Timetable
- From time of announcement of intention to takeover to actual takeover, there will be a 2-6 week period where the admins give the maintainer a chance to respond, with the exact time in any case up to the discretion of the admins.
- If someone has their package taken over because they did not respond, then, for the following year, should they request it, the admins will unconditionally return it to them.