Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Take "ownership" of "our" version of the IRI class #888

Open
5 tasks
jrfnl opened this issue Jul 29, 2024 · 0 comments
Open
5 tasks

Take "ownership" of "our" version of the IRI class #888

jrfnl opened this issue Jul 29, 2024 · 0 comments

Comments

@jrfnl
Copy link
Member

jrfnl commented Jul 29, 2024

The IRI class was originally externally maintained and imported into the project, however the external project has since ceased to exist and the class has had very little love over the years.

Along the same lines as the use in Requests, the IRI class is also still in use in the SimplePie project and possibly in other projects.

I propose we take ownership of the IRI class as used in Requests properly.

To do this, I see the following tasks:

  • Find the top 5 other projects which still use the IRI class.
  • Compare their current version with our version and see what we can learn from this.
  • Update the Requests IRI class with best practices from the other uses, including updating/adding tests (and giving credit where credit is due!!!).
  • Update the class docblock to fix the original copyright (name change) and add additional copyright for the newly brought in changes, including changes made by the Requests team.
  • Remove the "exception" status from the IRI class, i.e. make it comply with the Requests coding standards and remove any other exceptions in CI/QA for the IRI class.

Once these tasks are done, the IRI class should, as of that point in time, be treated like any other class in Requests and no longer have the "externally maintained" exception status.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant