Implement Jazzband guidelines for imaplib2

jazzband-bot commented 3 years ago

This issue tracks the implementation of the Jazzband guidelines for the project imaplib2

It was initiated by @graingert who was automatically assigned in addition to the Jazzband roadies.

See the TODO list below for the generally required tasks, but feel free to update it in case the project requires it.

Feel free to ping a Jazzband roadie if you have any question.

TODOs

[x] Fix all links in the docs (and README file etc) from old to new repo
[x] Add the Jazzband badge to the README file
[x] Add the Jazzband contributing guideline to the CONTRIBUTING.md or CONTRIBUTING.rst file
[x] Port tests to GitHub Actions (if not already there)
[x] Check if test coverage services work (e.g. Coveralls, Codecov, etc)
[x] Add jazzband account to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/imaplib2/collaboration/)
[x] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/imaplib2/users/)
[x] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/imaplib2/integrations/)
[x] Fix project URL in GitHub project description
[x] Review project if other services are used and port them to Jazzband
[x] Decide who is project lead for the project (if at all)
[x] Set up CI for Jazzband project releases if needed ~and open ticket if yes~
[x] open an issue at https://jazzband.co/roadies/issue for auto-release
[x] Change to an OSI-approved non-copyleft license (tracker: issue #18 )

Project details


Description	Fork of Piers Lauder's imaplib2 library for Python.
Homepage
Stargazers	11
Open issues	11
Forks	10
Default branch	master
Is a fork	False
Has Wiki	True
Has Pages	False

jezdez commented 3 years ago

@graingert Can you elaborate what "Fork of Piers Lauder's imaplib2 library for Python." means? Is there an original source code repo somewhere?

jezdez commented 3 years ago

@graingert Since we're currently moving to a new process for project proposals, could you fill in https://github.com/jazzband-roadies/help/issues/new?assignees=&labels=proposal&template=proposal.md&title=Proposal%3A+%3CPACKAGE+NAME%3E with the information need so we can review the transfer?

graingert commented 3 years ago

@jezdez

Since we're currently moving to a new process for project proposals

ah I wasn't aware of the new process

graingert commented 3 years ago

@graingert Can you elaborate what "Fork of Piers Lauder's imaplib2 library for Python." means? Is there an original source code repo somewhere?

@jezdez here's the old project page https://sourceforge.net/projects/imaplib2/ it links to the old github location at https://github.com/imaplib2/imaplib2/

jezdez commented 3 years ago

@jezdez

Since we're currently moving to a new process for project proposals

ah I wasn't aware of the new process

Right, no problem, it hasn't launched and just had been stalled by my work to port all projects to GitHub Actions.

jezdez commented 3 years ago

Jazzband member @piyueh has sent an email to all previous contributors of this project to propose moving from a "CNRI Python license" to a BSD 3-clause license. I'm mentioning it here since this should be taking into consideration while working on this TODO list above. I'd like to invite @piyueh to repeat the call here for full disclosure.

piyueh commented 3 years ago

@jezdez I added a new issue to gather the consents and added a new item to the TODO list.

jezdez commented 3 years ago

Hey all, what's the status on implementing the other TODOs above?

piyueh commented 3 years ago

@jezdez We are still missing consent from ~two developers~ one developer. I'll follow up on this task or see what options we have if we fail to gather the developer's consent.

piyueh commented 3 years ago

An issue was opened at https://github.com/jazzband/help/issues/226 for auto-release on PyPI. The remaining task is to decide a project lead.

@jezdez Is a project lead mandatory to make this issue move on?

@graingert Would you be willing to be the project lead?

If a project lead is mandatory and no one is able to take the role, I can take this role. However, I'm unfamiliar with IMAP stuff and may not be able to review PRs that are too technical about IMAP. What I can do is to make sure imaplib2 is functioning because I maintain relevant packages on Arch Linux AUR (e.g., python-imaplib2, offlineimap3-git, etc).

graingert commented 3 years ago

@graingert Would you be willing to be the project lead?

I'm also unfamiliar with IMAP stuff

jezdez commented 3 years ago

An issue was opened at jazzband/help#226 for auto-release on PyPI. The remaining task is to decide a project lead.

@jezdez Is a project lead mandatory to make this issue move on?

Yeah, it's optional in that I basically act as fallback and would review releases if nobody else becomes project lead. It's not a great situation since from experience slows down the release process. But the good news is that this is moot with https://github.com/jazzband/help/issues/227. 🥳

jezdez commented 3 years ago

One thing I was wondering is the https://github.com/jazzband/imaplib2/blob/21ae2ed26d0ca66c683483d1bfdc7c3fb567a048/imaplib2/imaplib2.html file inside the imap2lib package.

Could this be converted to a Sphinx project? Maybe Pandoc allows auto-coverting it to rST or Markdown?

I would really like to have user facing docs on https://imaplib2.readthedocs.io/ so it's clear what the purpose of imaplib2 is. What do you think?

graingert commented 3 years ago

Jannis Leidel) moved this from To do to Done in Migrate to GitHub Actions 23 minutes ago

should we close this and make fixing docs/coveralls new tickets?

jezdez commented 3 years ago

Jannis Leidel) moved this from To do to Done in Migrate to GitHub Actions 23 minutes ago

should we close this and make fixing docs/coveralls new tickets?

Works for me.

jazzband / imaplib2

Implement Jazzband guidelines for imaplib2 #13

TODOs

Project details