django-polymorphic
django-polymorphic copied to clipboard
Implement Jazzband guidelines for django-polymorphic
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
READMEfile - [x] Add the Jazzband contributing guideline to the
CONTRIBUTING.mdorCONTRIBUTING.rstfile - [x] Check if continuous testing works with GitHub Actions
- [x] Check if test coverage is tracked with Codecov
- [x] Add
jazzbandaccount to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/django-polymorphic/collaboration/) - [x] Add
jazzband-botas 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 |
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
@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
Add precommit - It looks like it's required https://github.com/jazzband/django-polymorphic/pull/557
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.
GHA and Codecov will be enabled by #561.
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.
@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
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.
We have merged PR #565 - At least for now we have coverage working.
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