Implement Jazzband guidelines for django-waffle

[jazzband-bot]

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

It was initiated by @clintonb 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

• Fix all links in the docs (and README file etc) from old to new repo
• Add the Jazzband badge to the README file
• Add the Jazzband contributing guideline to the CONTRIBUTING.md or CONTRIBUTING.rst file
• Check if continuous testing works with GitHub Actions
• Check if test coverage is tracked with Codecov
• Add jazzband account to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/django-waffle/collaboration/)
• Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-waffle/users/)
• Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-waffle/integrations/)
• Fix project URL in GitHub project description
• Review project if other services are used and port them to Jazzband
• 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	A feature flipper for Django
Homepage	https://waffle.readthedocs.io
Stargazers	1060
Open issues	43
Forks	258
Default branch	master
Is a fork	False
Has Wiki	False
Has Pages	False

[clintonb]

@jezdez can you help with configuring a repository secret for Codecov? How can I get access to do this, and finish ReadTheDocs setup, on my own?

[clintonb]

@jezdez I still need help with Codecov.

[dancergraham]

How about we add a code coverage action in this repo ? Is an external tool needed?

At my work we just run coverage.py in GH actions with a bot which posts the results back to the PR discussion.

[dancergraham]

Hello @jezdez we have now implemented coverage.py with Codecov but are getting this error:
error - 2025-01-22 08:06:49,435 -- Upload failed: {"message":"Token required because branch is protected"}
Can you help us to clear this please ?

[dancergraham]

Ping @jezdez will you be at djangocon Europe? Maybe we can discuss there, though it would be cool to fix this sooner if it just needs a repo secret...