docs: update README.md and CONTRIBUTING.md#567
Open
msampathkumar wants to merge 4 commits into
Open
Conversation
…e for samples. Also update contribution guide and provide tips on linter checks, typehints and pytests.
msampathkumar
requested review from
holtskinner and
zeroasterisk
and removed request for
zeroasterisk
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the project's configuration and documentation to improve the developer experience and project clarity. Key changes include increasing the Ruff line length to 100, adding uv.lock to the exclusion list, and providing comprehensive updates to CONTRIBUTING.md and README.md regarding setup, workflows, and protocol features. Additionally, testing and type-checking tools were added to pyproject.toml. Reviewers suggested moving development tools to a specific dependency group, correcting a typo, removing redundant CLI flags in documentation, and refining a heading for better conciseness.
msampathkumar
force-pushed
the
sampath_repo_readme
branch
from
06fb433 to
36f08a8
Compare
msampathkumar
changed the title
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.
Description
We are updating the repository's foundational documentation to streamline the onboarding experience for new contributors and ensure consistent code quality.
Summary of Updates:
README.md: Added a 2-step Quick Start guide for running the
helloworldsample and a Repository Structure directory table.CONTRIBUTING.md: Fully detailed the local development workflow using
uv. Added step-by-step commands for running linting (ruff), type checking (mypy/pyright), and test coverage (pytest).Tooling Configurations: Bumped
ruffline-length to 100 in.ruff.tomland add static analysis tools (mypy,pyright,pytest) inpyproject.toml.