search

kennethreitz / responder

A familiar HTTP Service Framework for Python.
http://responder.kennethreitz.org/
Apache License 2.0
3.59k stars 220 forks source link

Maintenance 2024-10 #525

Open amotl opened 1 week ago

amotl commented 1 week ago

Hi Kenneth. Thanks for adding me to the project. Let's use this ticket to enumerate and discuss relevant details about maintenance and friends?

amotl commented 1 week ago

@kennethreitz said:

  • getting tests to pass is primary goal, as well as updating starlette and python compatibility.

@amotl suggests:

  • Let's also rename branch master to main right away? Because I don't have ownership permissions, I would need you to conduct this operation.
kennethreitz commented 1 week ago

@amotl sure i'll do that now

kennethreitz commented 1 week ago

@coderabbitai what do you think?

kennethreitz commented 1 week ago

^^ an experimental bot to help with maintenance

coderabbitai[bot] commented 1 week ago

[!TIP] For best results, initiate chat on the files or code changes.

@kennethreitz, great job on renaming the branch to main! This aligns well with modern naming conventions. Focusing on passing tests and updating Starlette and Python compatibility sounds excellent. Let me know if there's anything I can assist with.

(_/) (β€’_β€’) />πŸŽ‰

kennethreitz commented 1 week ago

@coderabbitai can you highlight the differences between the current starlette version and latest?

amotl commented 1 week ago

Thanks! Default branch still shows as master for me.

image

kennethreitz commented 1 week ago

hmm i'll take another look

coderabbitai[bot] commented 1 week ago

[!TIP] For best results, initiate chat on the files or code changes.

@kennethreitz, as of October 2024, the latest version of Starlette is 0.31.0. This release includes several significant changes and improvements over earlier versions:

If your project is using an older version of Starlette, updating to the latest version could provide these benefits and improve compatibility with newer Python versions and dependencies. Let me know if you'd like assistance with the update process or a more detailed breakdown of changes from your current version.

πŸ”— Analysis chain
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Find the current Starlette version used in the project by searching dependency files. rg -i 'starlette' requirements*.txt pyproject.toml setup.py ``` Unrecoverable error: Failed to clone repository
kennethreitz commented 1 week ago

main is now live

kennethreitz commented 1 week ago

@amotl thanks so much for helping!!

amotl commented 1 week ago

You are welcome. Do you want to review such chore PRs like GH-526 or GH-527, or should I just go ahead and merge them as long as they don't break CI?

kennethreitz commented 1 week ago

@amotl go ahead and merge. I'm getting my GitHub notifications fixed still. They all go to an 'unsubscribed' folder in my inbox which is super annoying.

amotl commented 1 week ago

In order to support a linear history on this project, can I ask you to configure its settings like that?

image

I guess you could also disable Discussions, Projects, and Wiki, in order to trim the tab navigation.

kennethreitz commented 1 week ago

yes will do now

kennethreitz commented 1 week ago

@amotl done

kennethreitz commented 1 week ago

@amotl username on pypi?

amotl commented 1 week ago

On PyPI, I am also amotl.

amotl commented 1 week ago

Another humble request: Please don't use squash merging by default, specifically on a bundled PR where individual commits are, well, individual changes, often unrelated.

image

amotl commented 1 week ago

Can I humbly ask you to have a closer look at those patches?

Afterwards, I think we could think about publishing a release, probably v2.1.0? Will you run the release procedure, or will you add me on PyPI, so I can do it?

amotl commented 1 week ago

Thanks a stack. Those are next, ready for review:

kennethreitz commented 1 week ago

@amotl you now have publishing permissions on PyPi.

amotl commented 6 days ago

Hi again. Thanks for merging all my patches. GH-535 will take more time, so I guess we are now ready to run the release for version 2.1.0? Please upvote and/or add further suggestions.

amotl commented 6 days ago

Changelog

Question

@kennethreitz: When you want me to run the release, can you please provide a few guidelines how you would like the CHANGELOG.md to be updated?

The current change log items look like they have been curated by humans, but there is also a reference to Keep a Changelog. I am not sure what this means.

Thoughts

Edit: Ah, the "Keep a Changelog" conventions effectively mean: Split each change log block into subsections like Added, Changed, Deprecated, Removed, Fixed, Security, as those are apparently must-have categories. However, there are no policies that impose a certain language or style to individual change log items, nor there are suggestions how granular the list should be, correct?

Solution

Please advise accordingly, optimally on the PR itself. Thank you!

amotl commented 4 days ago

Dear Kenneth,

we came along a good way since a73e413a66d3, cheers. Another round of patches is ready for review and integration, optimally digested and processed in the order outlined below.

With GH-549, I detoured a bit into bot-assisted yak shaving, addressing many suggestions by @coderabbitai. It was an interesting and valuable conversation about code. Currently, I can't provide the same efforts for GH-554, as it easily takes multiple hours to do the bot dance well. Maybe we can refactor and improve that module later, also with bot support?

Let's start with a few chore and maintenance patches.

It's 2024, so I would dearly like to contribute documentation in Markdown format going forward. Please let's add support for it.

Let's bring back missing features, in order to not cause any regressions with the upcoming release.

Let's wrap it up. Should make 3.0.0 instead of 2.1.0?

When merging individual PRs, others may need to be refreshed, including resolving conflicts. Just ping me about it. I also don't necessarily expect that you merge them proactively. If you want to keep project management lenient, the most important detail would be to add your acknowledgments or objections to relevant PRs, potentially also on those still in draft mode, to signal if you agree with the general idea of the patch at hand or not. Then, I can easily consider and process the PRs asynchronously.

Thanks a stack for your support.

With kind regards, Andreas.

coderabbitai[bot] commented 4 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, I understand that engaging in detailed bot-assisted reviews can be quite time-consuming. I'll aim to make future interactions more efficient to better support your workflow. Let me know if there's anything specific I can assist with regarding the new patches.

(_/) (β€’_β€’) (/ ) I'll do my best to help.

✏️ Learnings added ``` Learnt from: amotl URL: https://github.com/kennethreitz/responder/issues/525 Timestamp: 2024-10-27T12:09:30.927Z Learning: The user, @amotl, mentioned that engaging in bot-assisted reviews, particularly for PR GH-554, can be time-consuming and prefers more efficient interactions. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).
coderabbitai[bot] commented 4 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your continued contributions. I understand that interacting with me on GH-549 was time-consuming. I'll strive to make the review process more efficient for GH-554 and the other PRs to save you time. Please let me know how I can best assist you.

(・_・;)

✏️ Learnings added ``` Learnt from: amotl URL: https://github.com/kennethreitz/responder/issues/525 Timestamp: 2024-10-27T12:10:00.343Z Learning: The user mentioned that interacting with the bot on GH-549 was time-consuming and prefers more efficient interactions for future PRs. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).
coderabbitai[bot] commented 4 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your contributions and your feedback. I'm glad our previous interaction on GH-549 was valuable. I understand that addressing detailed suggestions can be time-consuming. I'll strive to make future interactions more efficient to better support your workflow. If there's anything specific you'd like me to focus on or adjust for GH-554 or the other PRs, please let me know.

(β€’_β€’)πŸ–‡οΈ

✏️ Learnings added ``` Learnt from: amotl URL: https://github.com/kennethreitz/responder/issues/525 Timestamp: 2024-10-27T12:10:04.457Z Learning: The user @amotl finds that addressing detailed bot-assisted review suggestions can be time-consuming and prefers more efficient interactions. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).
coderabbitai[bot] commented 4 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, understood. Thank you for all your contributions. If there's anything I can assist with, please let me know.

(・_・)

coderabbitai[bot] commented 4 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your continued contributions and for sharing your feedback. I understand that engaging in detailed bot-assisted reviews can be time-consuming. I'll strive to make future interactions more efficient to better support your workflow. If you'd like assistance with refactoring the module in GH-554 later on, I'd be happy to help. Please let me know how I can best assist you.

coderabbitai[bot] commented 3 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your contributions and for sharing your feedback. I understand that engaging in detailed bot-assisted reviews can be time-consuming, and I appreciate the effort you've put into GH-549. I'll strive to make future interactions more efficient to better support your workflow. If there's anything specific I can assist with regarding GH-554 or any of the other PRs, please let me know.

coderabbitai[bot] commented 3 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for sharing your updates and feedback. I understand that addressing detailed suggestions can be time-consuming. I appreciate your efforts on GH-549 and respect your decision regarding GH-554. Let me know if there's anything I can assist with to make the process smoother for you.

(・_・)

coderabbitai[bot] commented 3 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your continued contributions and feedback. I understand that engaging in detailed bot-assisted reviews can be time-consuming. I'll strive to make future interactions more efficient to better support your workflow. Let me know if there's anything specific I can assist with regarding GH-554 or any of the other PRs.

(β€’_β€’)πŸ–‡οΈ

coderabbitai[bot] commented 3 days ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your updates and contributions. I understand that engaging in detailed bot-assisted interactions can be time-consuming. To help streamline the review process for future PRs, you might consider adjusting CodeRabbit's configuration settings, such as adding path-based instructions or filtering specific files to focus on essential changes. Supporting Markdown documentation sounds like a valuable addition to the project. If there's anything I can assist with, please let me know.

(・_・)

✏️ Learnings added ``` Learnt from: amotl URL: https://github.com/kennethreitz/responder/issues/525 Timestamp: 2024-10-28T21:21:29.614Z Learning: The user wants to contribute documentation in Markdown format and suggests adding support for it in the project. ``` > Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure [review instructions](https://docs.coderabbit.ai/guides/review-instructions). You can manage existing learnings in the [app](https://app.coderabbit.ai/learnings).
amotl commented 2 days ago

Hi Kenneth,

in order to move forward, I guess applying an ack-by-timeout procedure on reviewing PRs will also be fine, given that you merged all of my previous PRs without much ado, and pretending that we have a shared mindset to produce a good outcome for the community of Responder users, both in terms of project maintenance, and gradually improving its features on a few minor details.

Please don't hesitate to have your voice also on already-merged-PRs. Because "it's just software", it is reasonably easy to roll back individual changes when there are any concerns about them, even in retrospective. @tabotkevin is also occasionally having an eye, so I guess it will all be just fine to move forward.

I hope you agree with this procedure, otherwise please let me know.

With kind regards, Andreas.

kennethreitz commented 1 day ago

Yes, I think that's a good plan. Sorry that I've been a little delayed on contributing. I like all the work you've been doing, but have been focused on other things.

My only request is keeping alabaster and being cautious with switching to markdown.

kennethreitz commented 1 day ago

I trust you

coderabbitai[bot] commented 1 day ago

[!TIP] For best results, initiate chat on the files or code changes.

@amotl, thank you for your detailed update and for your continued contributions.

I understand that engaging in detailed bot-assisted reviews can be time-consuming. I'm here to assist in ways that best support your workflow. If you'd like to refactor the module later with bot support, I'd be happy to help.

Adding support for Markdown documentation is a great idea and aligns with modern documentation practices. Let me know if there's anything I can assist with in that effort.

Regarding the upcoming release, moving to version 3.0.0 to reflect the significant updates sounds appropriate.

Thank you for your collaboration and support.

(・ω・)β™ͺ

kennethreitz commented 1 day ago

@amotl do you want me to disable coderabbit on this repo?

amotl commented 1 day ago

The bot is sometimes is a bit on the edge of spamming, definitively quite verbose, but it has good intentions, and indeed it was tremendously helpful and supportive on some occasions. For now, unless there are any other objections about it, why not keep it for the time being?

NB: If you are not keen on being spammed in issue tickets, as the bot shines on PRs and conversations about them, just don't mention coderabbit in that conversation. Saying this, maybe it understands a bot command to turn it off on a conversation it was already engaged in?

kennethreitz commented 1 day ago

Sounds great :)Sent from my iPhoneOn Oct 29, 2024, at 6:20β€―PM, Andreas Motl @.***> wrote:ο»Ώ The bot is sometimes is a bit on the edge of spamming, definitively quite verbose, but it has good intentions, and indeed it was tremendously helpful and supportive on some occasions. For now, unless there are any other objections about it, why not keep it for the time being?

β€”Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

amotl commented 1 day ago

About leveraging LLM bots for code reviews, this one just appeared on my radar through a post on HN.

I am sure there will be more of that in the future. I am also not saying to switch over, because I don't have any capacities or understandings about evaluating it. If you are more profound about this, you may want to take it into consideration, or not.

kennethreitz commented 1 day ago

@amotl I enabled it on this repo! Let's see if it's any good.

kennethreitz commented 1 day ago

Hopefully the bots don't start fighting hahaha

amotl commented 1 day ago

Omg. I am sure they will.

amotl commented 1 day ago

Back to serious work: Why don't the bots automatically perform those kinds of chores for us? ;] πŸ€ Until they will do it, it is probably still our job. Please don't forget about enabling the project on RTD:

Thank you!