haskell / haskell/hackage-server
Docs improvement: upload a package
- Dominant language
- Haskell
- Stars
- 467
- Forks
- 225
- PR merge metrics
- No merged PRs in 30d
Description
Hello! Currently, I find the docs on uploading a package a bit confusing.
## What I read
1. [Uploading packages](https://hackage.haskell.org/upload):
If you upload a package or package candidate and no other versions exist in the package database, you become part of the maintainer group for that package, and you can add other maintainers if you wish.
1. [User accounts](https://hackage.haskell.org/accounts):
Once you have your account you can upload packages with new names, but not other existing packages.
1. [Register a new account](https://hackage.haskell.org/users/register-request):
After your account is created, you cannot upload until you contact the hackage trustees at hackage-trustees@haskell.org and send an email (including your login username) requesting to be added to the uploader group. (This measure is unfortunately necessary to prevent spam accounts).
So, according to 1., I can upload a package and then become a part of the maintainer group. According to 2. I can upload a package once I have an account. According to 3. After I have an account, I can't upload a package until I contact the trustees.
My questions:
- Should I send an e-mail each time I'd like to upload a package?
- How do I know if I'm in a certain group, e.g. uploaders?
- Where can I see the groups?
## What I'd like to read
(I may have misunderstood the Hackage mechanichs)
So, here's a guide on uploading a package:
1. Check if you're a Hackage user. Visit https://hackage.haskell.org/user/your_username.
1. If `your_username` is not found, you should register [here](https://hackage.haskell.org/users/register-request).
1. Next, send your username and a link to your package as an email to hackage-trustees@haskell.org
1. While waiting for an approval (a couple of days), polish your package. Follow the [docs](https://hackage.haskell.org/upload) on package candidates, versioning, licensing. Run e.g., `cabal haddock` to check the docs generated for your package.
1. The email from a trustee can be sent from a personal account, so, check your inbox and a spam folder.
1. If you don't receive an email in a reasonable time, send another email to hackage-trustees@haskell.org.
1. When your request is approved, you'll receive an email from a Hackage trustee. It will contain some hints on what can be improved in your package. Follow them.
1. Now, check that you're in the `Package uploaders` group at https://hackage.haskell.org/user/your_username
1. If no, repeat from the step 3.
1. Otherwise, upload a [Package candidate](https://hackage.haskell.org/upload#candidates). Check if it looks OK on Hackage
1. Again, visit https://hackage.haskell.org/user/your_username. As described in [Uploading a package/Privileges](https://hackage.haskell.org/upload), you're now in a `Maintainers` group of your package
1. Congrats! You can publish your package permanently.
1. As you're in the `Package uploaders` group, you may upload your other packages without asking the permission from Hackage trustees.
1. Happy contributing!
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.