Implement Jazzband guidelines for django-smart-selects

[jazzband-bot]

This issue tracks the implementation of the Jazzband guidelines for the project django-smart-selects

It was initiated by @digi604 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] Check if continuous testing works (e.g. Travis CI, CircleCI, AppVeyor, etc)
• [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/django-smart-selects/collaboration/)
• [x] Set up Readthedocs project (@manelclos)
• [x] Add Sphinx project and move current docs to it (@manelclos)
• [x] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-smart-selects/users/) (@jezdez)
• [x] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-smart-selects/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)
• [ ] Set up CI for Jazzband project releases if needed and open ticket if yes

Project details

Description	chained and grouped selects for django forms
Homepage
Stargazers	792
Open issues	49
Forks	282
Default branch	master
Is a fork	False
Has Wiki	False
Has Pages	False

[jezdez]

I've added an unusual item to the TODO list above: since the project doesn't have a Sphinx setup at the moment, this will have to be done in retrospect.

[manelclos]

@jezdez can anyone open PRs to fix items in the TODO list?

[jezdez]

@manelclos Any member of Jazzband, so as long as you've joined on jazzband.co you're good.

[jezdez]

@digi604 Please let me know if you have any questions.

[jezdez]

@digi604 Hey, please respond.

[jezdez]

To reiterate what I said over in https://github.com/jazzband/django-smart-selects/commit/05dcc4a3de2874499ff3b9a3dfac5c623206e3e5#commitcomment-36254287

Hi all and welcome to Jazzband! Thanks @digi604 for transferring the repo.

Since you haven't opened a ticket or got in touch with the Jazzband roadies (via https://github.com/jazzband-roadies/help) before transferring the repo as is customary, please make sure you more carefully re-read the Jazzband guidelines and the FAQ to familiarize yourself with Jazzband.

There is also a new ticket to track the process of applying the guidelines to this repo. Only when the TODOs in that ticket are done the transfer will be complete. Failing to do so will lead to the deletion of the repo.

You should note that I will delete repos that are not adopting the guidelines and solve the TODO list above. Since you have transferred the repo without prior check I'm eager for someone to get back to me when this will be done.

/cc @manelclos @blag @javierdaza

[jezdez]

The deadline for deletion is 1 week from writing this message.

[digi604]

jazzband was added to pypi

[digi604]

But i will not write some docs or setup sphinx. People begged me to hand this over to jazzband. So i did... but further maintenance is currently not possible.

[jezdez]

Thanks @digi604, could you please be more specific who asked you to move it to Jazzband?

It's fair to ask them to port the docs to Sphinx.

[manelclos]

Hi @digi604, thanks a lot for adding jazzband to pypi, I think that was the last detail we cannot handle.

@jezdez I'll take on those tasks, and if @blag want to help he is more than welcome.

I'll take on "Add Sphinx project and move current docs to it".

Thank you all!

[manelclos]

BTW, here is the conversation about moving the project to jazzband: https://github.com/jazzband/django-smart-selects/commit/05dcc4a3de2874499ff3b9a3dfac5c623206e3e5

[jezdez]

Thanks @manelclos!

[manelclos]

@jezdez there is now a PR for adding sphinx to the project. I moved current documentation from README.md and used a markdown plugin, hope that is ok. All sphinx files copied from django-axes to follow Jazzband style.

[manelclos]

@jezdez if there is anything I can do to move this further, please let me know.

[manelclos]

@jezdez ping

[manelclos]

@jezdez it would be great to finish this, currently the README.md file points to Readthedocs but the link is broken. I've merged all PRs so master has the latest code, and in the way of taking care of PRs.

[manelclos]

Hi @digi604, it seems Jazzband itself is suffering the problem it tried to prevent. Could you please add me to pypi while Jazzband chatches up on this?

Thanks!

[digi604]

added manelclos as a maintainer

[jezdez]

Hey friends, I can't add the needed webhook on the ReadTheDocs side since the jazzband-bot user wasn't added to the Readthedocs project on https://readthedocs.org/dashboard/django-smart-selects/users/. @manelclos @digi604 Can you please fix that?

Have you decided who should be the project lead for this project?

[manelclos]

@jezdez jazzband-bot is now added to Readthedocs. I can be the project lead until-if @digi604 wants to take over, as he stated he can't currently maintain the project.

[jezdez]

Fixed in ab3fd1bd13c2302ce4f847d73f38aba59fc1ff78.