refactor(python): readme improvements - #3825
Open
mmmmxa wants to merge 3 commits into
Open
Conversation
… workflow - small fixes
mmmmxa
marked this pull request as ready for review
August 5, 2026 17:20
Author
|
/ready |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR address?
Closes #3750
Rationale
The documentation provided in Python SDK does not provide a golden path for development workflow. The absence of golden path adds the cognitive load on most devs, especially the new ones.
What changed?
README for Python SDK now provides a clear instruction on how to build and test it and gives basic advice on troubleshooting for precommit and prepush hooks. The new path is tested by hand and has fixed a number of unwanted side effects described in the linked issue.
Local Execution
AI Usage
If AI tools were used, please answer: