Implement Jazzband guidelines for dj-ms-auth-router

[jazzband-bot]

This issue tracks the implementation of the Jazzband guidelines for the project dj-ms-auth-router

It was initiated by @HarleyK1ng 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
• [x] Add the Jazzband badge to the README file
• [x] 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
• [x] Add jazzband account to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/dj-ms-auth-router/collaboration/)
• [ ] Add jazzband-bot as maintainer to the Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/dj-ms-auth-router/users/)
• [ ] Add incoming GitHub webhook integration to Read the Docs project (e.g. URL: https://readthedocs.org/dashboard/dj-ms-auth-router/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)
• [ ] Set up CI for Jazzband project releases if needed and open ticket if yes

Project details

Description	Django package that helps to build microservices with django
Homepage
Stargazers	0
Open issues	0
Forks	0
Default branch	main
Is a fork	False
Has Wiki	True
Has Pages	False

[jezdez]

Hey @HarleyK1ng, this seems a little trivial for a project, wish you would have first opened a proposal like the others on https://github.com/jazzband/help/issues?q=is%3Aissue+is%3Aopen+label%3Aproposal.

What are your plans to add docs and tests for this?

[jezdez]

IIUC this requires django-auditlog, but it's not listed it in the install_requires fields? https://github.com/jazzband/dj-ms-auth-router/commit/a41ad1993f2b4b6d499b57a205a91762afbfb229

[AllYouZombies]

IIUC this requires django

no, it doesn't require django-auditlog but supports it

[AllYouZombies]

Hey @HarleyK1ng, this seems a little trivial for a project, wish you would have first opened a proposal like the others on https://github.com/jazzband/help/issues?q=is%3Aissue+is%3Aopen+label%3Aproposal.

What are your plans to add docs and tests for this?

I'm currently using this library and plan to use it in many future projects, so yes, I'll add tests / more documentation to this.

Sorry, my bad that I didn't opened proposal first

[jezdez]

I'm currently using this library and plan to it in many future projects, so yes, I'll add tests / more documentation to this.

Please double-check the Jazzband guidelines about what Jazzband projects should provide before initiating the transfer, in the "viability" section specifically.

In short, the functionality in this repo is trivial, it doesn't have documentation and lacks tests. The Jazzband organization focuses on projects that are well-established and non-trivial, which need additional maintainers. In other words, it's not for newly started projects.

Sorry, my bad that I didn't opened proposal first

I'll transfer the repo back to the https://github.com/dj-ms organization, please accept the transfer. Otherwise I'll be forced to delete the repo again.

[AllYouZombies]

got it...

[jezdez]

For some reason I can't transfer the repo back to the dj-ms org directly, I've requested transfer to your personal account instead.