Repository navigation
Document how to clone and run the included tests - #8
Merged
Merged
Conversation
Replace the README intro with the approved description and install commands. Python 3.11+ and the dev extra already match this repo. Co-authored-by: Dor Ingber <Doringber@users.noreply.github.com>
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
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.
What
Replaces the README opening with the approved description and a clone-and-run block. The banner title stays. Quick start and the rest of the README are unchanged and not duplicated.
Command check
The approved commands match this repo, so they were not rewritten:
requires-pythonis>=3.11, so “Python 3.11+” is correct.[project.optional-dependencies] devexists and includespytest(pluspytest-cov,ruff, andmypy), sopip install -e ".[dev]"is valid.## Quick startis an existing heading, so “See Quick start” refers to that section.pip install -e ".[dev]"was installed in a local venv. Pytest collected the suite from that install.Suggested GitHub repo description
Set this manually in the repository About settings:
pytest on main and PR #5
Open PR #5 is not merged, so it does not make the documented
pytestpass on currentmain. Afterpip install -e ".[dev]"on this branch (same tests asmain), plainpytestfails three tests:tests/test_version.py::test_read_version_fileandtest_resolve_version_matches_fileexpect0.1.1whileVERSIONis0.1.2.test_cursor_agent_client_normalizes_malformed_tool_payloadsfails whenmcpToolCallis a list: the run is reported successful instead of a malformed response.PR #5 fixes those three failures, and its CI is green (266 passed). Until that PR is merged,
pytestas documented in this README does not pass onmain. This change does not include that fix.