django-polymorphic icon indicating copy to clipboard operation
django-polymorphic copied to clipboard

Implement Jazzband guidelines for django-polymorphic

Open jazzband-bot opened this issue 1 year ago • 10 comments

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

It was initiated by @vdboor 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
  • [x] 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-polymorphic/collaboration/)
  • [x] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-polymorphic/users/)
  • [x] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/django-polymorphic/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 Improved Django model inheritance with automatic downcasting
Homepage https://django-polymorphic.readthedocs.io
Stargazers 1504
Open issues 161
Forks 267
Default branch master
Is a fork False
Has Wiki False
Has Pages True

jazzband-bot avatar Nov 22 '23 20:11 jazzband-bot

Code coverage used to be supported and updated PRs with numbers. eg:// https://github.com/jazzband/django-polymorphic/pull/461

It broke on https://app.codecov.io/gh/django-polymorphic/django-polymorphic/pull/496 and is visible if you check the uploads here https://app.codecov.io/gh/django-polymorphic/django-polymorphic/pulls

We're probably pretty close to having it back up and running

AdamDonna avatar Nov 23 '23 02:11 AdamDonna

@jezdez I'm seeing CI not using Travis any more and enforcing precommit. Do we need to migrate to github actions and add precommit?

Check if continuous testing works with GitHub Actions

Doesn't read as if it's an enforced migration

AdamDonna avatar Nov 23 '23 07:11 AdamDonna

Add precommit - It looks like it's required https://github.com/jazzband/django-polymorphic/pull/557

AdamDonna avatar Nov 23 '23 08:11 AdamDonna

Fixing all links in docs - https://github.com/jazzband/django-polymorphic/pull/559 I suspect the changes in setup.cfg might be breaking and require some caution.

AdamDonna avatar Nov 23 '23 10:11 AdamDonna

GHA and Codecov will be enabled by #561.

akx avatar Dec 11 '23 12:12 akx

A repository admin will need to follow the steps in https://app.codecov.io/gh/jazzband/django-polymorphic/new to get Codecov correctly set up.

akx avatar Dec 12 '23 10:12 akx

@jazzband-bot @jezdez @vdboor Do any of you have the ability to setup coverage for this project? It doesn't appear to be available for non-admins

AdamDonna avatar Dec 20 '23 10:12 AdamDonna

Looking at a recent build, the problem is that Codecov isn't finding the coverage file locally so cannot upload it. Please see PR https://github.com/jazzband/django-polymorphic/pull/565 to fix it.

hugovk avatar Dec 20 '23 10:12 hugovk

We have merged PR #565 - At least for now we have coverage working.

j-antunes avatar Jan 31 '24 19:01 j-antunes

Upon looking at the project I don't believe there are any other external services used by this project. I can volunteer to be a maintainer of this project. I need this project o support Django 5.0 since I use this package for my application

j-antunes avatar Jan 31 '24 19:01 j-antunes