Implement Jazzband guidelines for django-superform

[jazzband-bot]

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

It was initiated by @gregmuellegger 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 with GitHub Actions
• [ ] Check if test coverage is tracked with Codecov
• [x] Add jazzband account to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/django-superform/collaboration/)
• [x] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-superform/users/)
• [x] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-superform/integrations/)
• [x] Fix project URL in GitHub project description
• [x] Review project if other services are used and port them to Jazzband
• [ ] Decide who is project lead for the project (if at all) -> should be @panatale1
• [ ] Set up CI for Jazzband project releases if needed and open ticket if yes

Project details

Description	Add forms and formsets to other forms like they were fields.
Homepage	http://django-superform.readthedocs.org/
Stargazers	108
Open issues	14
Forks	36
Default branch	master
Is a fork	False
Has Wiki	True
Has Pages	False

[panatale1]

Please see PR #32 for documentation updates and a github workflow for continuous testing

[panatale1]

Got the pre-commit.ci stuff working, but github pipeline isn't running for some reason. i'll have to work on that later. For now, let's not merge the PR

[panatale1]

@gregmuellegger I think the github actions aren't running properly because the workflow hasn't been set up in the repo. I don't believe I have the ability to set up the workflow, but there is a .github/workflow/pipeline.yml file to set up the automated github actions

[gregmuellegger]

Hi @jezdez, I wanted to add the the webhooks for readthedocs, but I don't have access to the repo settings anymore. Maybe I can send you the URL and secret for the webhook so that you can set it up?

[gregmuellegger]

@panatale1 I have added a few more changes in #33

I cannot add you as contributor anymore, seems that only jazzband admins can do this (I don't have access to the repo settings anymore).

@jezdez could you please make @panatale1 a contributor of the project? (Is it correct to contact you for this?)

[jezdez]

Please join Jazzband on https://jazzband.co/join, which will give you write permissions to Jazzband repos. If you're interested in helping with a specific project, you may join a specific project team on https://jazzband.co/projects/django-superform afterward, so I can make you project lead.

[panatale1]

@jezdez roger that. I've joined the django-superform project per your directions

@gregmuellegger great. Would you like me to review your changes?

[panatale1]

@jezdez is Codecov usage included as part of jazzband, or do I have to sign up for my own account to set it up?

[gregmuellegger]

I have just invited jazzband as maintainer into the PyPI project.

@panatale1 Sorry I haven't been able to drive anything on the migration forward this week. I will have a look next week on what is open from my parts.

[gregmuellegger]

Ok so I think the steps going forward are:

• Create a PR that makes the repo work for modern Pythons and Django versions
• Once the PR is included the tests should be green again
• Once this is done we can create a release and automate that via GitHub Actions (which would check the " Set up CI for Jazzband project releases if needed and open ticket if yes" checkbox above)

@panatale1 would you be willing to create that PR and make superform work for newer Django versions?

[panatale1]

@gregmuellegger good news! I already worked on that. Just need to update the branch with a couple things first and can hopefully have that PR available in a few hours (gotta get the kid to school)