adamspd / django-appointment

A Django app for managing appointment scheduling with ease and flexibility.
Apache License 2.0
89 stars 30 forks source link

Request for Compatibility Table in Documentation #131

Closed OscarGonzalez97 closed 3 months ago

OscarGonzalez97 commented 4 months ago

Feature Description

As a user of a specific Django package, I frequently encounter challenges when determining the compatibility of different versions of the package with various versions of Django. It would be valuable to have a dedicated resource, such as a compatibility table or matrix, that clearly outlines which versions of the package are compatible with specific versions of Django.

The Ideal Solution

I envision a centralized resource within the documentation of the package, providing users with a comprehensive table or compatibility matrix.

The Current Solution

Currently, users often rely on scattered information from release notes, examples, and GitHub issues to determine compatibility between the package and Django versions.

Additional Context

Maybe something like this: image

Are you willing to help with the implementation?

Priority

How important is this feature to you?

adamspd commented 4 months ago

Hi @OscarGonzalez97,

Thank you for bringing that up and I completely agree that having a clear and centralized resource to outline the compatibility of different versions of the package with various Django versions would be beneficial.

I had indeed planned to add such a resource to the documentation. The groundwork has been laid, as I've implemented extensive tests. The next step, as you correctly pointed out, involves running these tests across the different Django environments to gather the necessary data for the compatibility table.

If you're interested in contributing to this effort. Here’s how you can get involved:

If you're ready to jump in, let me know, and we can start coordinating on this project. Otherwise, rest assured, I'll prioritize adding the compatibility table to the documentation in the next one to two weeks. Either way, your input is appreciated.

Looking forward to your response. Adams

adamspd commented 4 months ago

Resolved in #135

adamspd commented 4 months ago

Hi @OscarGonzalez97, is this what you had in mind ?

OscarGonzalez97 commented 3 months ago

Yes, that's it! thank you and sorry for the late response

adamspd commented 3 months ago

No worries, glad that is it.